API Base URL
https://api.daxko.com
Branches
The Branches API allows developers to retrieve information about an association's locations.
Get list of branches
Description
Retrieves all branches for the association
Responses
HTTP 200 OK
The ID of the branch.
B42
The name of the branch.
Downtown Branch
The branch's address.
123 Main Street
The branch's secondary address, if available.
Suite 600
The branch's city.
Birmingham
The branch's state.
AL
The branch's postal code.
35209
The branch's country
USA
Whether the branch is configured to show to members online.
true
A unique identifier for branch created by the client.
MW1
The phone number of the branch.
(205) 658-8956
The branch's configured branch hours
Whether the branch hours are configured.
Whether the branch is open or closed and when that status will change.
List of Open and Close times per day of the week for the branch.
List of Branch Hours exceptions and their availability
{
"branches": [
{
"id": "B1",
"name": "Branch 1",
"address1": "1234 Branch Lane",
"address2": "",
"city": "Homewood",
"state": "AL",
"zip_code": "35173",
"country": "US",
"show_online": true,
"branch_code": "MW1",
"phone": "(205) 985-6589",
"branch_hours": {
"branch_hours_configured": true,
"branch_availability_status": {
"status": "closed",
"until_date_time": "2023-08-17T16:00:00.0000000"
},
"schedule": [
{
"day": "Sunday",
"open_and_close": [
{
"open_time": "12:00:00",
"close_time": "18:00:00"
}
]
},
{
"day": "Monday",
"open_and_close": [
{
"open_time": "05:00:00",
"close_time": "22:00:00"
}
]
},
{
"day": "Tuesday",
"open_and_close": [
{
"open_time": "05:00:00",
"close_time": "22:00:00"
}
]
},
{
"day": "Wednesday",
"open_and_close": [
{
"open_time": "05:00:00",
"close_time": "22:00:00"
}
]
},
{
"day": "Thursday",
"open_and_close": [
{
"open_time": "05:00:00",
"close_time": "22:00:00"
}
]
},
{
"day": "Friday",
"open_and_close": []
},
{
"day": "Saturday",
"open_and_close": [
{
"open_time": "09:00:00",
"close_time": "12:00:00"
},
{
"open_time": "16:00:00",
"close_time": "21:00:00"
}
]
}
],
"exceptions": [
{
"start_date_time": "2023-08-17T15:00:00.0000000",
"end_date_time": "2023-08-17T16:00:00.0000000",
"available": false
},
{
"start_date_time": "2023-08-20T14:00:00.0000000",
"end_date_time": "2023-08-20T15:00:00.0000000",
"available": false
},
{
"start_date_time": "2023-08-20T18:00:00.0000000",
"end_date_time": "2023-08-20T20:00:00.0000000",
"available": true
}
]
}
},
{
"id": "B2",
"name": "Branch 2",
"address1": "45678 Branch Lane",
"address2": "",
"city": "Trussville",
"state": "AL",
"zip_code": "12345",
"country": "US",
"show_online": false,
"branch_code": "MW2",
"phone": "(205) 123-4567",
"branch_hours": {
"branch_hours_configured": true,
"branch_availability_status": {
"status": "open",
"until_date_time": "2023-08-17T17:00:00.0000000"
},
"schedule": [
{
"day": "Sunday",
"open_and_close": [
{
"open_time": "05:00:00",
"close_time": "21:00:00"
}
]
},
{
"day": "Monday",
"open_and_close": []
},
{
"day": "Tuesday",
"open_and_close": []
},
{
"day": "Wednesday",
"open_and_close": []
},
{
"day": "Thursday",
"open_and_close": []
},
{
"day": "Friday",
"open_and_close": []
},
{
"day": "Saturday",
"open_and_close": []
}
],
"exceptions": [
{
"start_date_time": "2023-08-17T15:00:00.0000000",
"end_date_time": "2023-08-17T17:00:00.0000000",
"available": true
},
{
"start_date_time": "2023-08-19T18:00:00.0000000",
"end_date_time": "2023-08-19T21:00:00.0000000",
"available": true
}
]
}
},
"..."
]
}
Get branch details
Description
Returns details about an association's specific branch
Path Parameters
The ID of the branch.
B42Responses
HTTP 200 OK
The ID of the branch.
B42
The name of the branch.
Downtown Branch
The branch's address.
123 Main Street
The branch's secondary address, if available.
Suite 600
The branch's city.
Birmingham
The branch's state.
AL
The branch's postal code.
35209
The branch's country
USA
Whether the branch is configured to show to members online.
true
A unique identifier for branch created by the client.
MW1
The phone number of the branch.
(205) 658-8956
The branch's configured branch hours
Whether the branch hours are configured.
Whether the branch is open or closed and when that status will change.
List of Open and Close times per day of the week for the branch.
List of Branch Hours exceptions and their availability
{
"id": "B1",
"name": "Branch 1",
"address1": "1234 Branch Lane",
"address2": "",
"city": "Homewood",
"state": "AL",
"zip_code": "35173",
"country": "US",
"show_online": true,
"branch_code": "MW1",
"phone": "(205) 123-4567",
"branch_hours": {
"branch_hours_configured": true,
"branch_availability_status": {
"status": "closed",
"until_date_time": "2023-08-17T16:00:00.0000000"
},
"schedule": [
{
"day": "Sunday",
"open_and_close": [
{
"open_time": "12:00:00",
"close_time": "18:00:00"
}
]
},
{
"day": "Monday",
"open_and_close": [
{
"open_time": "05:00:00",
"close_time": "22:00:00"
}
]
},
{
"day": "Tuesday",
"open_and_close": [
{
"open_time": "05:00:00",
"close_time": "22:00:00"
}
]
},
{
"day": "Wednesday",
"open_and_close": [
{
"open_time": "05:00:00",
"close_time": "22:00:00"
}
]
},
{
"day": "Thursday",
"open_and_close": [
{
"open_time": "05:00:00",
"close_time": "22:00:00"
}
]
},
{
"day": "Friday",
"open_and_close": []
},
{
"day": "Saturday",
"open_and_close": [
{
"open_time": "09:00:00",
"close_time": "12:00:00"
},
{
"open_time": "16:00:00",
"close_time": "21:00:00"
}
]
}
],
"exceptions": [
{
"start_date_time": "2023-08-17T15:00:00.0000000",
"end_date_time": "2023-08-17T16:00:00.0000000",
"available": false
},
{
"start_date_time": "2023-08-20T14:00:00.0000000",
"end_date_time": "2023-08-20T15:00:00.0000000",
"available": false
},
{
"start_date_time": "2023-08-20T18:00:00.0000000",
"end_date_time": "2023-08-20T20:00:00.0000000",
"available": true
}
]
}
}
Get branch areas
Description
Retrieves a list of all areas in a branch. Please note that a virtual branch cannot have areas and are thus excluded from this endpoint.
Path Parameters
The ID of the branch.
B12Responses
HTTP 200 OK
The total number of areas in the branch.
1
A list of areas in the branch.
The ID of the area.
A14
The name of the area.
Area_1
Whether the area provides child-watch.
true
Whether the area has an age restriction.
true
The youngest a member can be to be allowed in the area.
8
The oldest a member can be to be allowed in the area.
14
Whether the capacity-tracking feature is enabled for the area.
false
The maximum capacity of the area.
70
Whether the area is active.
true
Whether the checkout feature is enabled.
true
{
"total": 3,
"areas": [
{
"id": "A1",
"name": "Area_1",
"is_active": true,
"is_childwatch": true,
"is_checkout_allowed": true,
"age_restriction": false,
"enforce_capacity": false
},
{
"id": "A2",
"name": "Area_2",
"is_active": true,
"is_childwatch": true,
"is_checkout_allowed": true,
"age_restriction": true,
"age_from": 18,
"age_to": 27,
"enforce_capacity": false,
"capacity": 2
},
{
"id": "A3",
"name": "Area_3",
"is_active": true,
"is_childwatch": false,
"is_checkout_allowed": true,
"age_restriction": false,
"enforce_capacity": false
}
]
}
Get branch current capacity
Description
Retrieves real-time details about the branch's attendance, including how many people are currently checked in and whether the branch enforces a maximum on the number of people allowed at the facility.
Path Parameters
The ID of the branch.
B42Responses
HTTP 200 OK
The maximum number of individuals who are allowed to be at the branch at one time. If this value is null, it means the value has not been configured and capacity-tracking is not enabled.
430
Whether the branch enforces a maximum number of individuals who are allowed to be checked in at the same time.
true
The total number of people who are currently checked in at the time of the request.
43
The percentage of the capacity at the time of the request.
10
Whether the branch currently allows members to check out of the branch.
false
If this value is set, a member will be automatically checked out after the configured period has elapsed following a check-in.
120
Get branch available fees
Description
Retrieves a list of available fees in a branch. Please note that virtual branches cannot have fees and are thus excluded from this endpoint.
Path Parameters
The ID of the branch.
B42Query Parameters
Filters result on the enabled status of fees.
allall, enabled, disabled
The page number of the response. If not included in request, its default value will be 1.
The number of fees fetched per response, defaulting to 25.
Responses
HTTP 200 OK
The total number of fees fetched on this page of the response.
1
A list of fees.
The ID of the fee.
59384
The name of the fee.
Cafeteria Plan Withholding
The description of the fee.
Fees for Cafeteria
The amount of fee, formatted as money.
$0.00
The amount of fee, formatted as decimal.
0
Whether the fee is monthly recurring.
false
The status of the fee.
true
Whether sales tax is applicable on the fee.
false
Whether there are more records on the next page.
false
Get sites by branch
Description
Retrieves a list of sites associated with the branches.
Query Parameters
Array of branch ids.
B12,B11If true, include inactive sites in the response.
truefalseResponses
HTTP 200 OK
A list of all the sites associated with branches
The ID of the branch with which site is associated.
B21
The name of the branch with which site is associated.
YMCA branch
The ID of the site.
S01
The name of the site.
YMCA site
The description of the site.
YMCA site
Whether the site is active.
true
{
"sites": [
{
"branch_id": "B27",
"branch_name": "YMCA Branch",
"site_id": "S01",
"site_name": "YMCA site",
"site_description": "YMCA site",
"is_active": true
}
]
}
Get branch check-ins
Description
Retrieves a list of check-ins in a branch within a particular date range.
Query Parameters
The start date in UTC format.
2020-01-15The end date in UTC format.
2020-01-31The ID of the branch.
B27The page number.
1The number of records to be fetched.
10Responses
HTTP 200 OK
The total number of records returned.
1
A list of all the check-ins within the date range.
The member ID of the member.
300180933-01
The name of the member.
Adams, Adam
The details of the check-in.
The date and time the member checked in in UTC format.
2020-06-29T13:08:58.5900000Z
Details about the checked-in location.
The ID of the branch.
B27
The type of the location.
branch
branch
The name of the branch.
Blocker/Norfolk Family YMCA
{
"total": 1,
"checkins": [
{
"member_id": "300180933-01",
"member_name": "Adams, Adam",
"check_in": {
"date": "2020-06-29T13:08:58.5900000Z",
"location": {
"id": "B27",
"type": "branch",
"name": "Blocker/Norfolk Family YMCA"
}
}
}
],
"has_more_records": false
}
Virtual Branch Check In
Description
Check in a single member to the Virtual Branch using his or her member_id
Request Body
The member_id of the given member
300181797-01
Responses
HTTP 200 OK
Indicates if the operation succeeded. If it did not, then the errors collection will contain additional information.
Financials
The Financials API allows developers to view financial information and transactions for an association.
Get Transactions
Description
Retrieves all the transactions for the organization over a specific timeframe.
Query Parameters
Optionally, whether to filter the query by the category of transaction. If not specified, it will default to all transactions.
all_transactionsall_transactions, fees, payments
The start date for the search date range. If not specified, it will default to 30 days ago.
2020-02-15The end date for the search date range. If not specified, it will default to 30 days from the start date.
2020-02-26The page number of the response. If not included in the request, its default value will be 1.
1The number of transactions fetched per response, defaulting to 25.
20Responses
HTTP 200 OK
The total number of transactions fetched on this page of the response.
1
A list of transactions.
The Credit/Debit/Payment ID of the transaction.
53363142
The timestamp (in UTC) when the transaction occurred.
2020-07-10T16:06:01.4770000
The ID of the unit for the transaction.
90000059443
The description of the transaction.
Super Cool After School Program — 5 days a week (12/29/14 - 06/01/15)
The amount for the transaction, including taxes, formatted as money.
$750.00
The amount for the transaction, including taxes, in decimal format.
750
The type of transaction (e.g. credit or debit).
Debit
The type of credit or debit applied (e.g., Payment, Fees, Discount, Cancellation, etc.).
Fees
The total taxes for the transaction, formatted as money.
$0.00
The total taxes for the transaction, in decimal format.
0
The registration ID of the program the transaction is related to (only available if the type of the program is Child Care).
4474636
The type of program.
Child Care
Whether there are more records on the next page.
false
Fundraising
The Fundraising API allows developers to manage fundraising and campaign data for an organization.
List campaigns
Description
Retrieves all the campaigns for an association.
Query Parameters
The timeframe by which to optionally filter the query.
currentcurrent, past, upcoming
The ID of the campaign season by which to optionally filter the query.
76The ID of the campaign template by which to optionally filter the query.
72The ID of the branch by which to optionally filter the query.
B23The page number over which to iterate.
1The number of records to be fetched.
10Responses
HTTP 200 OK
The number of records returned.
1
Whether there are more records to be fetched on subsequent calls.
false
The list of campaigns.
The ID of the campaign.
23
The code assigned to the campaign.
C2020-1
The name of the campaign.
2020 Capital Improvements
Whether the campaign is setup for online donations.
true
The total amount the association is targeting to raise.
100000
Details about the campaign template.
The ID of the campaign template.
2
The code assigned to the template.
XA2
The name of the template.
Annual campaign
Details about the campaign season.
The ID of the campaign season.
23
The code assigned to the season.
XFR20
The name of the season.
2020 Campaign
The date for the campaign starts.
2020-01-01T00:00:00+0000
The date for the campaign ends.
2021-01-01T00:00:00+0000
Basic information about an association's branch.
The ID of the branch.
B42
The name of the branch.
Downtown Branch
Add campaign
Description
Adds a new campaign for an association.
Request Body
The code of the campaign.
ABC
The name of the campaign.
ABC Campaign
The branch ID of the campaign.
B123
The tempate ID of the campaign.
234
The season ID of the campaign.
567
The goal amount of the campaign.
0
100.05
The revenue GL ID of the campaign.
45634
The cash GL ID of the new campaign.
45667
Whether online donations are allowed for the campaign.
false
true
Whether to generate "Thank You" letters for donations for new pledges.
false
true
Whether to generate "Thank You" letters for donations for each payment.
false
true
Whether to generate "Thank You" letters for donations for pledge completion.
false
true
The online campaign name that will appear in all online giving screens. This property is required if the allow_online_giving property is set to true.
ABC Online Campaign
A list of email addresses, to which a confirmation will be sent after any contribution is made.
["example@example.com","test@example.com"]
Whether to send email confirmation for pledges given for in-house donations.
false
true
Whether to send email confirmation for pledges given for online donations.
false
true
Responses
HTTP 201 Created
The ID of the campaign created.
1234
Get Campaign by ID
Description
Retrieves the details of a campaign.
Path Parameters
The ID of the campaign.
4891Responses
HTTP 200 OK
The ID of the campaign.
23
The code assigned to the campaign.
C2020-1
The name of the campaign.
2020 Capital Improvements
Whether the campaign is setup for online donations.
true
The total amount the association is targeting to raise.
100000
Details about the campaign template.
The ID of the campaign template.
2
The code assigned to the template.
XA2
The name of the template.
Annual campaign
Details about the campaign season.
The ID of the campaign season.
23
The code assigned to the season.
XFR20
The name of the season.
2020 Campaign
The date for the campaign starts.
2020-01-01T00:00:00+0000
The date for the campaign ends.
2021-01-01T00:00:00+0000
Basic information about an association's branch.
The ID of the branch.
B42
The name of the branch.
Downtown Branch
Delete Campaign
Description
Deletes a campaign.
Path Parameters
The ID of the campaign.
4891Responses
HTTP 204 No Content
Get Campaign Stats
Description
Retrieves the stats of a campaign.
Path Parameters
The ID of the campaign.
4891Responses
HTTP 200 OK
The name of the campaign.
2020 Capital Improvements
The total amount the association is targeting to raise.
10000
The total amount that has been pledged toward the campaign.
1400
The total amount that has been contributed to the campaign.
184.3
The part of the pledged amount that hasn't been contributed to the campaign yet.
1215.7
The amount that has been written-off from the campaign.
5.7
The number of pledges made to the campaign.
5
The number of donors for the campaign.
4
The number of prospects for the campaign.
3
The number of declining prospects of the campaign.
0
The number of outstanding prospects of the campaign.
2
The number of in-kind gifts received by the campaign.
0
The percent of amount pledged to that of goal amount of the campaign.
35
The percentage contributed toward the campaign goal.
4.61
The percentage to be paid toward the campaign pledge.
86.84
Start of the associated Campaign Season
End of the associated Campaign Season
List campaigners
Description
Retrieves all the campaigners for an association, along with the campaigns they are associated with.
Query Parameters
The ID of the campaign by which to optionally filter the query.
11The ID of the campaign season by which to optionally filter the query.
76The ID of the campaign template by which to optionally filter the query.
72The ID of the branch by which to optionally filter the query.
B23The wildcard name of the campaigner by which to optionally filter the query. Please note that, should you wish to search by full name, the format to use would be {lastName}, {firstName}.
Finch, AtticusThe page number over which to iterate.
1The number of records to be fetched.
10Responses
HTTP 200 OK
The number of records returned.
1
Whether there are more records to be fetched on subsequent calls.
false
The list of campaigners.
The ID of the campaigner.
200023-01
The campaigner's first name.
Atticus
The campaigner's middle name.
L.
The campaigner's last name.
Finch
The ID of the membership unit the campaigner belongs to.
200023
The campaigner's member ID.
200023-01
The campaigner's phone number.
(555) 555-5555
The campaigner's email address.
atticus.finch@example.com
Details about the campaign.
The ID of the campaign.
23
The code assigned to the campaign.
C2020-1
The name of the campaign.
2020 Capital Improvements
Details about the campaign template.
The ID of the campaign template.
2
The code assigned to the template.
XA2
The name of the template.
Annual campaign
Details about the campaign season.
The ID of the campaign season.
23
The code assigned to the season.
XFR20
The name of the season.
2020 Campaign
The date for the campaign starts.
2020-01-01T00:00:00+0000
The date for the campaign ends.
2021-01-01T00:00:00+0000
Basic information about an association's branch.
The ID of the branch.
B42
The name of the branch.
Downtown Branch
List campaign seasons
Description
Retrieves all the campaign seasons for an association.
Query Parameters
The start date of the campaign. If left blank, it will default to the start of the year.
2020-09-01The end date of the campaign. If left blank, it will default to the end of the year (when the start date is not present) or the end of the start date's year.
2021-08-31The page number over which to iterate.
1The number of records to be fetched.
10Responses
HTTP 200 OK
The number of records returned.
1
Whether there are more records to be fetched on subsequent calls.
false
The list of campaign seasons returned.
The ID of the campaign season.
23
The code assigned to the season.
XFR20
The name of the season.
2020 Campaign
The date for the campaign starts.
2020-01-01T00:00:00+0000
The date for the campaign ends.
2021-01-01T00:00:00+0000
Add campaign season
Description
Adds a new campaign season for an association.
Request Body
The code of the campaign season.
ABC
The name of the campaign season.
ABC Season
The start date of the campaign season.
2020-12-31
The end date of the campaign season.
2021-12-31
Responses
HTTP 201 Created
The ID of the campaign season created.
1234
Get campaign season by ID
Description
Retrieves the details of a particular campaign season.
Path Parameters
The ID of the campaign season.
1234Responses
HTTP 200 OK
The ID of the campaign season.
23
The code assigned to the season.
XFR20
The name of the season.
2020 Campaign
The date for the campaign starts.
2020-01-01T00:00:00+0000
The date for the campaign ends.
2021-01-01T00:00:00+0000
Delete campaign season
Description
Deletes a campaign season.
Path Parameters
The ID of the campaign season.
1234Responses
HTTP 204 No Content
List campaign templates
Description
Retrieves all the campaign templates for an association.
Query Parameters
The page number over which to iterate.
1The number of records to be fetched.
10Responses
HTTP 200 OK
The number of records returned.
1
Whether there are more records to be fetched on subsequent calls.
false
The list of campaign templates returned.
The ID of the campaign template.
2
The code assigned to the template.
XA2
The name of the template.
Annual campaign
Get campaign-template details
Description
Retrieves details about a specific campaign template.
Path Parameters
The ID of the campaign template
24Responses
HTTP 200 OK
The ID of the campaign template.
2
The code assigned to the template.
XA2
The name of the template.
Annual campaign
A description of the campaign.
The annual campaign to keep our members strong and our community stronger.
The slogan for the campaign.
For a stronger us.
List campaign types
Description
Retrieves all the campaign types. Please note that campaign types are shared for all Daxko Operations customers.
Responses
HTTP 200 OK
The number of campaign types returned.
1
The different campaign types available.
The ID of the campaign type.
6
The name of the campaign type.
Corporate fundraiser
A description of the campaign type.
Use this type when designating campaigns tied to a corporate challenge.
Search for donors
Description
Retrieves a paginated list of donors, either members or organizations, who have made donations to the organization, based on the provided criteria.
Query Parameters
The type of donor by which to filter the results.
organizationdonors_only, all_members, organization
The ID of the campaign by which to optionally filter the query.
76The name of the donor by which to optionally filter the query.
Smith MaterialsWhen used in conjunction with the campaign_id query string, setting this parameter will filter the results to individuals or organizations who have been marked as assigned donors to a particular campaign. If omitted or set to false, it will only return those who are past donors to the supplied campaign. Please note that this parameter will only filter results when the campaign_id query-string parameter is also supplied.
THe last time the donor made a donation. Using this parameter will filter records to those who have been donated since the date specified.
2020-02-22T13:44:51ZTHe last time the donor was contacted. Using this parameter will filter records to those who have been contacted since the date specified.
2020-02-22T13:44:51ZTHe next time the donor is to be contacted. Using this parameter will filter records to those who have should be contacted after the date specified.
2020-02-22T13:44:51ZThe page number over which to iterate.
1The number of records to be fetched.
10Responses
HTTP 200 OK
The number of records returned.
1
Whether there are more records to be fetched on subsequent calls.
false
The list of donors.
The ID of the donor.
FDO25342345
The type of donor.
organization
member, organization
The name of the donor, which may be an individual or an organization.
Smith Materials LLC
The ID of the unit associated with the donor.
25342345
The ID of the member associated with the donor, only available if the donor is a member.
25342345-01
The next time the donor is to be contacted.
2020-03-22T13:44:51Z
The last time the donor record was updated.
2020-02-22T13:44:51Z
List GL Accounts By Type
Description
Retrieves the specific type of GL accounts available for fundraising.
Query Parameters
The type of GL accounts to be fetched.
cash_glcash_gl, revenue_gl
The page number.
11The number of records to be fetched.
1025Responses
HTTP 200 OK
The number of records returned.
1
Whether there are more records to be fetched on subsequent calls.
false
The list of GL accounts.
The ID of the GL account.
1234
The name of the GL account.
ABC Account
The account number of the GL account.
111-11-1234
The name of GL account, with the publicly-displayed account number.
(111-11-1234) ABC Account
The type of the GL account.
Asset
Whether the GL account is available for memberships.
true
Whether the GL account is available for programs.
true
Whether the GL account is available for fundraising.
true
Whether the GL account is available for fee setup.
true
Whether the GL account is available for all branches.
true
Whether the GL account is enabled.
true
The common name of the GL account.
Cash Account
Program Registration
The Program Registration Carts API is used to register a member for programs, packages, child care and camp.
Create a cart
Description
Creates a cart that can be used for subsequent cart API calls.
Responses
HTTP 201 Created
The ID of the cart that was created. Use this ID for any program registration API calls that
require the cart_id as a path parameter.
NOTE: This cart_id is only valid for program registration API calls and cannot be used for any membership API calls.
d9e6ddd1-6d99-4623-b44c-cdd9450ed5bc
Start program offering registration
Description
This call starts the process of registering a member for offerings of a single program by adding it to the cart.
Depending on how the program is set up, additional calls may be needed in order for this member and offering combination to be available for
checkout. For example, if the program.type is anything but camp, then the "Choose instances to register for" step must be completed. If
custom questions must be answered, then the questions step must be completed before checking out.
Rules:
- If the offering is a child care or package program, only one offering can be passed in.
- If the offering is a camp or traditional program, more than one offering is allowed.
Example:
{
"program_id": "CC1234",
"offerings": [{
"offering_id": "RP445555",
"location_id": "B2222"
}],
"member_id": "10000-01",
"registration_type": "online",
"dry_run": false
}
The product_bundle_id value that is returned from this call in combination with the cart_id value will be used in subsequent calls to
build up the rest of the registration.
Path Parameters
The ID used to uniquely represent the cart.
ee8b0997-9861-4302-a0bf-f8f68fc50522Request Body
The member being registered
The Program ID for the offering being added to the cart
List of offerings for registration
Offering ID for the offering being added to the cart
Location ID associated with selected Offering ID
Specifies the type of registration (we currently only support online)
in_house, online
When set to true, will only run the validation and not actually add to cart.
falseResponses
HTTP 200 OK
Indicates if the item was added to the cart. If dry_run is true this will only indicate if the item would be added to the cart. If this returns false it means the item was not added to the cart and you should check the errors collection.
ID used to represent all items related to a given offering and any associated products.
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
Common information about product bundle.
Steps that a part of the registration process.
These steps must be completed in order for the registration to be available for check out.
Contains information about the product being purchased.
Root product ID. For program registrations, this will be the program id.
TMP5333444
Root product description. For program registrations, this will be the program name.
My Program
Items that are below the root product in hierarchy.
Sub-product ID. For program registrations, this will be the offering id.
SES4444222
Sub-product Name. For program registrations, this will be the offering name.
My Session
Information about person being registered
Member ID
1234678-01
Full name of member
John Doe
{
"success": true,
"product_bundle_id": "ee8b0997-9861-4302-a0bf-f8f68fc50522",
"info": {
"steps": {
"required": [
"instances",
"agreements",
"questions",
"review"
]
},
"products": [
{
"id": "TMP61918",
"name": "My Program",
"children": [
{
"id": "SES912409",
"name": "Session #1"
}
]
}
],
"person": {
"id": "300181439-01",
"full_name": "Bruce Aldrich"
}
},
"links": [
{
"rel": "instances",
"href": "/carts/aa46bcf4-b65a-4a37-bed9-5dcb4674d0a3/product_bundles/26d2fe9a-c6d8-437b-83fb-cbe0063de31b/instances"
}
]
}
Get possible instances to register for
Description
After an offering registration has been started and added to the cart, this returns the list of instances that are available for registration.
Program Package Notes
The following is an axample of the additional property that will be included when the program.type is package
...
"instructors": [
{
"id": "INS22124",
"first_name": "John",
"last_name": "Doe",
"gender": "M"
},
{
"id": "INS22125",
"first_name": "Sally",
"last_name": "Jones",
"gender": "F"
}
]
Child Care Notes
The following is an example of additional properties that will be included when the program.type is child_care
...
"days": [
{
"id": 1,
"name": "Monday",
"enabled": true,
"selected": false
},
{
"id": 2,
"name": "Tuesday",
"enabled": false,
"selected": false
}
],
"min_required_days": 1
Camp Notes
If the program.type is camp, then this step is not valid since all of the offerings have been chosen in the add to cart step and there
is not additional information that needs to be collected.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aThe ID of the product bundle (registration).
97ae13b3-c646-abca-fb01-e8855ecd879bResponses
HTTP 200 OK
Common information about product bundle.
Steps that a part of the registration process.
These steps must be completed in order for the registration to be available for check out.
Contains information about the product being purchased.
Root product ID. For program registrations, this will be the program id.
TMP5333444
Root product description. For program registrations, this will be the program name.
My Program
Items that are below the root product in hierarchy.
Sub-product ID. For program registrations, this will be the offering id.
SES4444222
Sub-product Name. For program registrations, this will be the offering name.
My Session
Information about person being registered
Member ID
1234678-01
Full name of member
John Doe
Program information
Program ID
Program type
standard, package, child_care
Program name
Expiration date for program package instances. For other instance types, the expires property is omitted.
Instances
Instance ID that will be used in the Choose Instances call
Descriptive name of the instance (will only have a value if program.type is package).
Start date of instance (will not have value if program.type is package since package programs are on-going).
End date of instance (will not have value if program.type is package since package programs are on-going).
Due date for payment of instance (will not have value if program.type is package since package programs are on-going).
Value is true if instance is available to be registered for. An example of a case where this will be false is if there is a child care availability exception or if the instance is full.
Whether or not the is selected for registration. For example, if you choose this instance in the PUT call and later make the GET call, this will be true. This value is not actually used for registration, but is a helper to keep track of state.
Fee amount for this instance. In order to calculate how much will actually cost the member with scholarships taken into account, the formula is amount - sum(discounts.amount).
Whether or not the member will be on the waiting list if this instance is selected for registration.
Information about the parent offering.
Related offering id
Related offering name
Discounts (for example, scholarship) that will be automatically applied during registration.
Display name of type of discount
Type of discount
school
Amount of discount
Discount percentage. 0.15 means a 15% discount.
Fees that will be charged automatically (for example, registration fee)
Fee type
reg_fee
Display name of fee type
Fee amount
Available instructors to choose from (property will only exist if program.type is package)
Instructor ID
Instructor first name
Instructor last name
Instructor gender
M, F
Day options to choose from when registering for a child care program (property will only exist if program.type is child_care)
ISO8601 day of week ordinal (1 = Monday, ..., 7 = Sunday)
1, 2, 3, 4, 5, 6, 7
Display name for day of week
Monday
Whether or not the day is available for registration (controlled by the rate plan set up)
Whether or not the day is selected. For example, if you choose this instance in the PUT call and later make the GET call, this will be true. This value is not actually used for registration, but is a helper to keep track of state.
Minimum required days that must be chosen in order to register. This property will only exist if program.type is child_care.
{
"info": {
"steps": {
"required": [
"instances",
"agreements",
"questions",
"review"
]
},
"products": [
{
"id": "TMP61918",
"name": "My Program",
"children": [
{
"id": "SES912409",
"name": "Session #1"
}
]
}
],
"person": {
"id": "300181439-01",
"full_name": "Bruce Aldrich"
}
},
"program": {
"id": "TMP61918",
"type": "standard",
"name": "My Program"
},
"instances": [
{
"id": "54d590a7-8909-4a58-a056-42afc408f352",
"name": "",
"start_date": "2050-01-01T00:00:00.0000000",
"end_date": "2050-12-31T00:00:00.0000000",
"due_date": "2050-01-01T00:00:00.0000000",
"enabled": true,
"selected": true,
"amount": 100,
"waiting_list": false,
"offering": {
"id": "SES912409",
"name": "Session #1"
},
"discounts": [
{
"type": "schol",
"name": "Scholarship",
"amount": 10,
"percent": 0.1
}
]
},
{
"id": "64d590a7-8909-4a58-af56-42afc408fabc",
"name": "",
"start_date": "2050-01-01T00:00:00.0000000",
"end_date": "2050-12-31T00:00:00.0000000",
"due_date": "2050-01-01T00:00:00.0000000",
"enabled": true,
"selected": true,
"amount": 150,
"waiting_list": false,
"offering": {
"id": "SES912999",
"name": "Session #2"
},
"discounts": [
{
"type": "schol",
"name": "Scholarship",
"amount": 15,
"percent": 0.1
}
]
}
],
"fees": [
{
"type": "reg_fee",
"name": "Registration Fee",
"amount": 5.75
}
]
}
Choose instances to register for
Description
This call is used to choose which instances to register for after adding an offering to the cart and getting the
list of possible instances from the GET call. If the program.type is camp, then this step is not valid.
Example:
{
"instances": [
{ "id": "b90d74c1-9d9d-4ecc-8414-04cdf398337b" },
{ "id": "b2bb1212-7830-46d0-b76d-21a9d3a42044" }
],
"days": [1, 3, 5],
"instructor_id": "INS1234"
}
The info.steps.required property and the links property of the response can be used to determine what the next step in the process should be.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aThe ID of the product bundle (registration).
97ae13b3-c646-abca-fb01-e8855ecd879bRequest Body
Instances to register for
Instance ID to register for
Which days of week to register for. This is an ISO8601 day of week ordinal (1=Monday, ... , 7=Sunday). For example, [1, 3, 5] would choose Mon, Wed, and Fri.
This property is only valid if program.type is child_care
Instructor ID to choose. This property is only valid if program.type is package and is always optional.
Responses
HTTP 200 OK
Indicates whether the operation succeeded. An example of where this would be false is if the member already has all of these instances in this cart.
Common information about product bundle.
Steps that a part of the registration process.
These steps must be completed in order for the registration to be available for check out.
Contains information about the product being purchased.
Root product ID. For program registrations, this will be the program id.
TMP5333444
Root product description. For program registrations, this will be the program name.
My Program
Items that are below the root product in hierarchy.
Sub-product ID. For program registrations, this will be the offering id.
SES4444222
Sub-product Name. For program registrations, this will be the offering name.
My Session
Information about person being registered
Member ID
1234678-01
Full name of member
John Doe
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
{
"success": true,
"info": {
"steps": {
"required": [
"instances",
"agreements",
"questions",
"review"
]
},
"products": [
{
"id": "TMP61918",
"name": "My Program",
"children": [
{
"id": "SES912409",
"name": "Session #1"
}
]
}
],
"person": {
"id": "300181439-01",
"full_name": "Bruce Aldrich"
}
},
"links": [
{
"rel": "questions",
"href": "/carts/aa46bcf4-b65a-4a37-bed9-5dcb4674d0a3/product_bundles/26d2fe9a-c6d8-437b-83fb-cbe0063de31b/questions"
},
{
"rel": "agreements",
"href": "/carts/aa46bcf4-b65a-4a37-bed9-5dcb4674d0a3/product_bundles/26d2fe9a-c6d8-437b-83fb-cbe0063de31b/agreements"
},
{
"rel": "review",
"href": "/carts/aa46bcf4-b65a-4a37-bed9-5dcb4674d0a3"
}
]
}
Get custom questions
Description
After an offering registration has been started and added to the cart, this returns the list of custom questions that are available for answering. Use this to build answers to pass to the Save answers API call.
See the dxp-questions-ui Javascript library on GitHub for an example implementation of rendering and answering custom questions. Feel free to use this library directly or fork it to customize it.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aThe ID of the product bundle (registration).
97ae13b3-c646-abca-fb01-e8855ecd879bResponses
HTTP 200 OK
Common information about product bundle.
Steps that a part of the registration process.
These steps must be completed in order for the registration to be available for check out.
Contains information about the product being purchased.
Root product ID. For program registrations, this will be the program id.
TMP5333444
Root product description. For program registrations, this will be the program name.
My Program
Items that are below the root product in hierarchy.
Sub-product ID. For program registrations, this will be the offering id.
SES4444222
Sub-product Name. For program registrations, this will be the offering name.
My Session
Information about person being registered
Member ID
1234678-01
Full name of member
John Doe
Whether answers will be edited or created. If mode is create, then no answers exist yet. If mode is edit, then answers already exist and will be edited.
create, edit
This is a dictionary where the question id is the key mapping to an object that defines the question.
"questions": {
"question_1": { "title": "Question 1", ... },
"question_2": { "title": "Question 2", ... }
}
Type of question
section, text, name, date, dropdown, radio, checkboxes, phone, address, email
Question title
Name
Question description/additional instructions.
Please fill first name first
Value is true if an answer to the question is required.
true
Value is true if the question should be rendered in the UI as read only.
true
Maximum text length allowed for questions of type text and email.
22
Default value. Exists only for questions of type dropdown, checkboxes, and radio.
Selected
List of possible answers. Exists only for questions of type dropdown, checkboxes, and radio.
Possible answer ID
childcare_possible_answer-103476
Possible answer value
Medium
Fee amount for this answer. Exists only when there is a fee.
10.00
Display friendly value.
Medium - $10.00
Value is true if the UI should not show an empty option. For example, the dropdown might by default say 'Select One', but if this value is true then 'Select One' should not be shown.
true
Defines what is considered an empty value for this question. For example, the value 'U' might be considered an empty value and will throw a validation error if this value is selected. Exists only for questions of type dropdown, checkboxes, and radio.
U
Regular expression to validate input against. Exists only for questions of type email.
^\d+$
Value is true if phone extension number should be rendered in UI. Exists only for questions of type phone.
true
Value is true if this is an international address or phone number question. Exists only for questions of type phone and address.
true
Value is true if first name should be rendered in UI. Exists only for questions of type name.
true
Value is true if middle name should be rendered in UI. Exists only for questions of type name.
true
Value is true if last name should be rendered in UI. Exists only for questions of type name.
true
Value is true if name prefix should be rendered in UI. Exists only for questions of type name.
true
Value is true if name suffix should be rendered in UI. Exists only for questions of type name.
true
Value is true if first name is required. Exists only for questions of type name.
true
Value is true if middle name is required. Exists only for questions of type name.
true
Value is true if last name is required. Exists only for questions of type name.
true
List of available name prefixes.
ID of prefix
Mr.
Display value of prefix
Mr.
List of available name suffixes.
ID of suffix
Jr.
Display value of suffix
Jr.
Canada province list. Exists only for questions of type address when intl is true.
Province code
AB
Display name of province
British Columbia
Country list. Exists only for questions of type address when intl is true.
Country code
US
Display name of province
Canada
This is a dictionary where the question ID is the key mapping to an object that defines the answer to that question.
"answers": {
"question_1": "answer text...",
"question_5": {"phone": "555-555-5555"}
}
{
"info": {
"steps": {
"required": [
"instances",
"agreements",
"questions",
"review"
]
},
"products": [
{
"id": "TMP61918",
"name": "My Program",
"children": [
{
"id": "SES912409",
"name": "Session #1"
}
]
}
],
"person": {
"id": "300181439-01",
"full_name": "Bruce Aldrich"
}
},
"mode": "edit",
"questions": {
"sect_program_58883": {
"type": "section",
"title": "This is the first section of questions",
"description": "These are the instructions"
},
"program_mediumtext-213704": {
"type": "text",
"title": "What color is the sky?",
"description": "",
"required": false,
"read_only": false,
"max_length": 50
},
"program_phone-213705": {
"type": "phone",
"title": "What is your phone number?",
"description": "",
"required": false,
"read_only": false,
"show_extension": true,
"intl": false
},
"program_answerlist-213706": {
"type": "dropdown",
"title": "What is your favorite letter?",
"description": "",
"required": false,
"read_only": false,
"possible_answers": [
{
"id": "program_possible_answer-104587",
"value": "A",
"display_value": "A"
},
{
"id": "program_possible_answer-104588",
"value": "B",
"display_value": "B"
},
{
"id": "program_possible_answer-104589",
"value": "C",
"display_value": "C"
}
],
"hide_empty_option": false,
"empty_value": ""
},
"program_answerlist-213707": {
"type": "checkboxes",
"title": "Choose 1 or more options below",
"description": "",
"required": false,
"read_only": false,
"possible_answers": [
{
"id": "program_possible_answer-104590",
"value": "A",
"amount": 10,
"display_value": "A - $10.00"
},
{
"id": "program_possible_answer-104591",
"value": "B",
"amount": 20,
"display_value": "B - $20.00"
},
{
"id": "program_possible_answer-104592",
"value": "C",
"amount": 20,
"display_value": "C - $20.00"
}
],
"hide_empty_option": false,
"empty_value": ""
},
"program_address-213708": {
"type": "address",
"title": "What is your address?",
"description": "",
"required": false,
"read_only": false,
"intl": false
},
"program_answerlist-213709": {
"type": "radio",
"title": "What is your favorite letter?",
"description": "",
"required": false,
"read_only": false,
"possible_answers": [
{
"id": "program_possible_answer-104593",
"value": "A",
"display_value": "A"
},
{
"id": "program_possible_answer-104594",
"value": "B",
"display_value": "B"
},
{
"id": "program_possible_answer-104595",
"value": "C",
"display_value": "C"
}
],
"hide_empty_option": false,
"empty_value": ""
},
"program_datetime-213710": {
"type": "date",
"title": "What is your birth date?",
"description": "",
"required": false,
"read_only": false
},
"program_email-213711": {
"type": "email",
"title": "What is your email address?",
"description": "",
"required": false,
"read_only": false,
"max_length": 100,
"pattern": "^\\w+([-+.']\\w+)*@\\w+([-.]\\w+)*\\.\\w+([-.]\\w+)*$"
},
"program_name-213712": {
"type": "name",
"title": "What is your mother's name?",
"description": "",
"required": false,
"read_only": false,
"show_first": true,
"show_middle": false,
"show_last": true,
"show_prefix": false,
"show_suffix": true,
"required_first": false,
"required_middle": false,
"required_last": false,
"suffixes": [
{
"id": "Jr.",
"value": "Jr."
},
{
"id": "Sr.",
"value": "Sr."
},
{
"id": "I",
"value": "I"
},
{
"id": "II",
"value": "II"
},
{
"id": "III",
"value": "III"
},
{
"id": "IV",
"value": "IV"
},
{
"id": "V",
"value": "V"
}
]
}
},
"answers": {
"program_mediumtext-213704": "purple",
"program_phone-213705": {
"phone": "555-555-5555",
"ext": "123"
},
"program_answerlist-213706": "program_possible_answer-104589",
"program_answerlist-213707": [
"program_possible_answer-104591",
"program_possible_answer-104592"
],
"program_address-213708": {
"line1": "111 Some Dr",
"line2": "Ste 208",
"city": "Homewood",
"state": "AL",
"zip": "35209",
"country": "US"
},
"program_answerlist-213709": "program_possible_answer-104594",
"program_datetime-213710": "1/1/2010",
"program_email-213711": "me@example.com",
"program_name-213712": {
"first": "Sally",
"last": "Doe",
"suffix": "III"
}
}
}
Save answers
Description
This call is used to save custom question answers. In the example below, the key is the question id from Get custom questions and the value is the answer.
Example body:
{
"program_mediumtext-213704": "purple",
"program_phone-213705": {
"phone": "555-555-5555",
"ext": "123"
},
"program_answerlist-213706": "program_possible_answer-104589",
"program_answerlist-213707": [
"program_possible_answer-104591",
"program_possible_answer-104592"
],
"program_address-213708": {
"line1": "111 Some Dr",
"line2": "Ste 208",
"city": "Homewood",
"state": "AL",
"zip": "35209",
"country": "US"
},
"program_answerlist-213709": "program_possible_answer-104594",
"program_datetime-213710": "1/1/2010",
"program_email-213711": "me@example.com",
"program_name-213712": {
"first": "Sally",
"last": "Doe",
"suffix": "III"
}
}
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aThe ID of the product bundle (registration).
97ae13b3-c646-abca-fb01-e8855ecd879bResponses
HTTP 200 OK
Indicates whether the operation succeeded.
Common information about product bundle.
Steps that a part of the registration process.
These steps must be completed in order for the registration to be available for check out.
Contains information about the product being purchased.
Root product ID. For program registrations, this will be the program id.
TMP5333444
Root product description. For program registrations, this will be the program name.
My Program
Items that are below the root product in hierarchy.
Sub-product ID. For program registrations, this will be the offering id.
SES4444222
Sub-product Name. For program registrations, this will be the offering name.
My Session
Information about person being registered
Member ID
1234678-01
Full name of member
John Doe
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
{
"success": true,
"info": {
"steps": {
"required": [
"instances",
"agreements",
"questions",
"review"
]
},
"products": [
{
"id": "TMP61918",
"name": "My Program",
"children": [
{
"id": "SES912409",
"name": "Session #1"
}
]
}
],
"person": {
"id": "300181439-01",
"full_name": "Johnny Doe"
}
},
"links": [
{
"rel": "agreements",
"href": "/carts/aa46bcf4-b65a-4a37-bed9-5dcb4674d0a3/product_bundles/26d2fe9a-c6d8-437b-83fb-cbe0063de31b/agreements"
},
{
"rel": "review",
"href": "/carts/aa46bcf4-b65a-4a37-bed9-5dcb4674d0a3"
}
]
}
Get agreements
Description
This call is used to retrieve all agreements associated with a product bundle.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aThe ID of the product bundle (registration).
97ae13b3-c646-abca-fb01-e8855ecd879bResponses
HTTP 200 OK
Common information about product bundle.
Steps that a part of the registration process.
These steps must be completed in order for the registration to be available for check out.
Contains information about the product being purchased.
Root product ID. For program registrations, this will be the program id.
TMP5333444
Root product description. For program registrations, this will be the program name.
My Program
Items that are below the root product in hierarchy.
Sub-product ID. For program registrations, this will be the offering id.
SES4444222
Sub-product Name. For program registrations, this will be the offering name.
My Session
Information about person being registered
Member ID
1234678-01
Full name of member
John Doe
If set to type_name, then these agreements are set up to accept a typed name as the signature. If set to signature, then these agreements are set up to accept a signature image.
type_name, signature
The list of agreements for the product_bundle_id
The agreement ID
The agreement title
The actual text of the agreement
Indicates whether the agreement has previously been accepted
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
{
"info": {
"steps": null,
"products": [
{
"id": "TMP62009",
"name": "Adult Swimming Lessons",
"children": null
},
{
"id": "SES912539",
"name": "Session 1 (11/1/2017 - 11/6/2017)"
}
],
"person": {
"id": "300180856-01",
"full_name": "John Doe"
}
},
"signature_type": "type_name",
"agreements": [
{
"agreement_id": "W293",
"title": "Make up policy",
"body": "I agree that you will forfeit your lesson fee if I do not cancel within 2 hours of class start time.",
"accepted": false
},
{
"agreement_id": "W297",
"title": "Consent for emergency medical treatment",
"body": "I grant authorization to a licensed physician to treat msyelf in case of a medical emergency.",
"accepted": true
}
],
"links": [
{
"rel": "agreements",
"href": "/carts/c80464db-a47f-4f8c-b66c-c4cb4957b4ae/product_bundles/f0f588cc-702e-403d-a24c-102df4995953/agreements"
},
{
"rel": "questions",
"href": "/carts/c80464db-a47f-4f8c-b66c-c4cb4957b4ae/product_bundles/f0f588cc-702e-403d-a24c-102df4995953/questions"
},
{
"rel": "review",
"href": "/carts/c80464db-a47f-4f8c-b66c-c4cb4957b4ae"
}
]
}
Accept agreements
Description
This call is used to save and sign agreements associated with a program. Either signee_name or signature_image_base64 is required.
Example body with signee_name:
{
"agreement_ids": ["W293"],
"signee_name": "John Doe"
}
Example body with signature_image_base64:
{
"agreement_ids": ["W293"],
"signature_image_base64": "iVBORw..."
}
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aThe ID of the product bundle (registration).
97ae13b3-c646-abca-fb01-e8855ecd879bRequest Body
A list of required agreement_ids for the product bundle.
["W3982","W221"]
The name of the signee.
John Doe
Base64 encoded PNG signature image. This should be a black and white image with the pen stroke being black like the one being generated by this signature pad plugin.
iVBORw0KGgoAAAANSUhEUgAAAV8AAAA6...
Responses
HTTP 200 OK
Common information about product bundle.
Steps that a part of the registration process.
These steps must be completed in order for the registration to be available for check out.
Contains information about the product being purchased.
Root product ID. For program registrations, this will be the program id.
TMP5333444
Root product description. For program registrations, this will be the program name.
My Program
Items that are below the root product in hierarchy.
Sub-product ID. For program registrations, this will be the offering id.
SES4444222
Sub-product Name. For program registrations, this will be the offering name.
My Session
Information about person being registered
Member ID
1234678-01
Full name of member
John Doe
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
{
"success": true,
"info": {
"steps": null,
"products": [
{
"id": "TMP62009",
"name": "OPS-21274",
"children": [
{
"id": "SES912539",
"name": "Session 1 (11/1/2017 - 11/1/2020)"
}
]
}
],
"person": {
"id": "300180856-01",
"full_name": "caleb tucker"
}
},
"links": [
{
"rel": "agreements",
"href": "/carts/c80464db-a47f-4f8c-b66c-c4cb4957b4ae/product_bundles/f0f588cc-702e-403d-a24c-102df4995953/agreements"
},
{
"rel": "questions",
"href": "/carts/c80464db-a47f-4f8c-b66c-c4cb4957b4ae/product_bundles/f0f588cc-702e-403d-a24c-102df4995953/questions"
},
{
"rel": "review",
"href": "/carts/c80464db-a47f-4f8c-b66c-c4cb4957b4ae"
}
]
}
Get Cart Details
Description
Retrieves the line items of a cart. This call must be made prior to finalizing an order.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aResponses
HTTP 200 OK
The cart version serves as a verification value that an order has been reviewed before being finalized. It will need to be passed into the cart checkout API call.
A list of line items that have been added to the cart
The line item ID.
307b94ae-fb6f-4382-b623-9b772ae07c83
The ID of the product bundle this line item belongs
97ae13b3-c646-abca-fb01-e8855ecd879b
The line item type. A description of each type is detailed in the table below.
| type | description |
|---|---|
| reg_fee | Registration Fee |
| question_fee | Question Fee |
| inst | Instance Fee |
reg_fee, question_fee, inst
The line item full description.
The line item short description.
The line item first-level grouping. This is only used for display purposes.
The line item second-level grouping. This is only used for display purposes.
The line item third-level grouping. This is only used for display purposes.
The line item fourth-level grouping. This is only used for display purposes.
The line item price per unit.
The line item quantity.
The price for all quantities. Equal to quantity * unit_price.
Indicates whether the line_item can be deleted from the cart. For example, you can delete a program offering but not a registration fee.
The date when the min_payment_amount is due.
How much of the extended_price is due immediately.
The amount that will be paid by the payment method.
The amount that will be paid by system credit.
The balance amount due after discounts, system_credit_amount, and payment_method_amount
Balance if min_payment_amount is paid. This value is independent of how much is paid toward the line_item. For example, if a unit's extended_price is $100, and the min_payment_amount is $15, then the due_later_amount will always be $85.
A list of discounts applied to the line item.
The type of discount applied. A description of each type is detailed in the table below.
| type | description |
|---|---|
| promo | Promo code |
| schol | Scholarship |
promo, schol
Dollar amount of discount
Discount description
The percentage amount
A list of the amount that will be paid for each line item. This is provided for convenience so that it doesn't have to be manually constructed. However, for more advanced payment scenarios (if your application wants to specify per line item payments), your application will need to construct it. It will be required for the finalize payment API call.
The line item ID
141039c2-f0c0-4513-be20-b3d92024489a
The line item amount
The indicates if that in the event the required amount is not paid, that any remaining balance is automatically applied to the member's account.
trueList of all product bundles in the cart. Use the product_bundle_id in the line_items collection to reference the product bundle.
The product bundle id
241039c3-f0c0-4513-be20-b3d92024487b
The status of the product bundle. complete means that all of the required steps have been completed and the product bundle
is available for checkout. incomplete means that one or more of the required steps needs to be completed in order for the product bundle
to be available for checkout.
complete, incomplete
Common information about product bundle.
Steps that a part of the registration process.
These steps must be completed in order for the registration to be available for check out.
Contains information about the product being purchased.
Root product ID. For program registrations, this will be the program id.
TMP5333444
Root product description. For program registrations, this will be the program name.
My Program
Items that are below the root product in hierarchy.
Sub-product ID. For program registrations, this will be the offering id.
SES4444222
Sub-product Name. For program registrations, this will be the offering name.
My Session
Information about person being registered
Member ID
1234678-01
Full name of member
John Doe
Indicates if the cart requires payment now or at some point in the future.
Indicates the max amount that can be applied to the entire cart. This can be used for validation purposes to ensure that an error is not returned from the API for specifying an amount that exceeds the total amount.
Delete a cart
Description
Deletes a cart, and all product bundles, and frees any reserved spots.
Path Parameters
The ID of the cart to delete
77ae13b3-c645-4bca-bb01-d8855ecd879aResponses
HTTP 200 OK
Indicates whether the cart was deleted.
true
Remove product bundle from cart
Description
Removes a product bundle from the cart, and frees any reserved spots.
A call to GET /v1/carts/{cart_id} will return the updated cart information.
Path Parameters
The ID of the cart with the product bundle to delete
77ae13b3-c645-4bca-bb01-d8855ecd879aThe ID of the product bundle to delete
97ae13b3-c646-abca-fb01-e8855ecd879bResponses
HTTP 200 OK
Indicates whether the product bundle was deleted.
true
Delete line item
Description
Deletes a line item from cart (if possible), recalculates cart total and frees any reserved spots.
A call to GET /v1/carts/{cart_id} will return the updated cart information.
Path Parameters
The ID of the cart which the line item belongs
77ae13b3-c645-4bca-bb01-d8855ecd879aThe ID of the line item to delete
Responses
HTTP 200 OK
Indicates whether the line item was deleted.
true
Apply promo code to cart
Description
Apply promo code to cart. Once the promo code is applied, call get cart details and inspect line_items.discounts where type is promo to see result of promo code.
Example Body:
{
"promo_code": "FALL20OFF"
}
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
Promo code
Responses
HTTP 200 OK
Indicates if the operation succeeded or not.
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
{
"success": true,
"links": [
{
"rel": "review",
"href": "/carts/77ae13b3-c645-4bca-bb01-d8855ecd879a"
}
]
}
Delete promo code from cart
Description
Once a promo code has been applied to the cart, use this call to remove it.
Example Body:
{
"promo_code": "FALL20OFF"
}
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
Promo code
Responses
HTTP 200 OK
Indicates if the operation succeeded or not.
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
{
"success": true,
"links": [
{
"rel": "review",
"href": "/carts/77ae13b3-c645-4bca-bb01-d8855ecd879a"
}
]
}
Apply payment amounts
Description
This call allows you to optionally apply payment amounts top down to items in the cart. On the final checkout api call, you must
provide the line_item_payments mapping, which is a mapping of line_item_id to amount.
This represents how much money (payment method amount plus system credit amount) will applied to each line item.
If you do not want to manually calculate this mapping, you can use this api call as a convenient way to calculate this mapping for you.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
Total amount that will be applied using the payment method (for example: VISA or Bank Account)
Total amount that will be applied using available system credit. If you request more system credit than is available, an error will occur.
Responses
HTTP 200 OK
Indicates whether the operation succeeded. If it did not, then the errors collection will contain additional information.
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
{
"success": true,
"links": [
{
"rel": "review",
"href": "/carts/d2850a5a-3976-43a3-b7b4-2bc7e00ceee4"
}
]
}
Program Registration One-time Link
Description
Generates a one-time link (valid for 10 minutes) that takes the user to a page in Daxko Operations Online to finish the Program Registration process. One the link has been used once, it is no longer valid.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
URI to redirect to after Program Registration process succeeds.
https://www.example.org/my_success_page
Step to show in the browser.
pay
Name to show on the receipt.
John Doe
Email to show the receipt to.
john.doe@example.org
Show or hide the Daxko Operations Online header. Defaults to show
show, hide
Responses
HTTP 200 OK
One-time URL to redirect user to in order to complete process in Daxko Operations Online
https://operations.daxko.com/online/9991/cart/redirector.mvc?code=_qNGKAKowkSmHDzCN6y8zT4bxCCD2LZgBN8m4ko_6E0&__header=show&__footer=hide&__nav=hide
{
"url": "https://operations.daxko.com/online/9991/cart/redirector.mvc?code=_qNGKAKowkSmHDzCN6y8zT4bxCCD2LZgBN8m4ko_6E0&__header=show&__footer=hide&__nav=hide"
}
Checkout
Description
This call completes the registration. Once the registration is submitted, it is processed asynchronously. The status can be checked using the get cart status api call. However, the Get Receipt call is immediately available.
Example request body:
{
"version": "AAAAAAmirMM=",
"customer": {
"name": "John Doe",
"email": "john.doe@example.org"
},
"payment_info": [
{
"payment_method_amount": 90,
"apply_system_credit_amount": 10,
"billing_method": {
"id": "PTLvg3hhYLPUqaBJcHIybjIokxLwR6RHG4zdhF6zZQdZM",
"save": true
},
"line_item_payments": [
{
"line_item_id": "4f04bd57-a51b-4d55-85ea-b6f4d7a64090",
"amount": 40,
"schedule_remaining": false
},
{
"line_item_id": "fe591b03-79a6-4d07-a0ac-64574a35896d",
"amount": 60,
"schedule_remaining": false
}
]
}
]
}
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
The get cart api call returns back this version value every time the call is made. The latest version must be included when performing the final checkout as a check to make sure that the most up to date has been reviewed.
AAAAAAmirMM=
Information about the customer that is checking out.
Name of customer that is performing purchase. This name will be returned in the receipt api call.
John Doe
Customer's email address that the receipt will be emailed to. If this is left blank, then an email will not be sent.
john.doe@example.org
Payment info for payment method. Only 1 payment method at a time is currently supported.
Amount that is being paid from the specified payment method (i.e., $100 is being paid by a VISA payment method)
90
If system credit is available on the account, this is the amount that is being paid from available system credit.
10
Information about billing method used to pay for this cart. Not required if payment is not being collected and the balance should go on the unit's account.
ID of billing method. Is either a Daxko Payment Token (prefixed with 'PT') or a stored billing method in Daxko Operations (prefixed with 'BM')
PTLvg3hhYLPUqaBJcHIybjIokxLwR6RHG4zdhF6zZQdZM
Should the information on the Daxko Payment Token be stored for future use as a stored billing method in Daxko Operations? (This property is ignored if using an id prefixed with BM since it is already stored in Daxko Operations).
false
true
This is a mapping of how much of the total payment amount (payment_method_amount + apply_system_credit_amount) is applied to each line item. The sum of all line_item_payments.amount must equal (payment_method_amount + apply_system_credit_amount). An entry is required for each line item even if applying $0.
The ID of the line item from the get cart api call.
4f04bd57-a51b-4d55-85ea-b6f4d7a64090
Amount of payment_method_amount + apply_system_credit_amount that should be applied to this line item. For example, if payment_method_amount is $90 and apply_system_credit_amount is $10 and this amount is $20, this means that $20 of the $100 will be applied to this line item.
40
This only applies if the full balance of this line item is not being immediately paid. If true, then a scheduled payment will be automatically created on the line item's due date for the remaining balance. If false, then the balance will remain on the account and must be handled manually within Daxko Operations.
true
true
Responses
HTTP 200 OK
Indicates if the operation succeeded. If it did not, then the errors collection will contain additional information.
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
{
"success": true,
"links": [
{
"rel": "receipt",
"href": "/receipts/d2850a5a-3976-43a3-b7b4-2bc7e00ceee4"
},
{
"rel": "status",
"href": "/carts/d2850a5a-3976-43a3-b7b4-2bc7e00ceee4/status"
}
]
}
Get Cart Status
Description
Retrieves the status of a cart.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aResponses
HTTP 200 OK
The status of the cart.
empty, open, closed, processing
A more descriptive explanation of the status.
Get Cart Receipt
Description
This call gets the receipt of a submitted cart. The receipt is immediately available, but the cart is processed asynchronously and the status can be checked with the Get cart status api call.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aResponses
HTTP 200 OK
Date/time the cart was checked out at (UTC)
2010-10-12T21:06:58.6460000Z
A list of payments that have been made against this cart
Display name of the payment payment_method
Bank Draft
Name on the payment method name_on_account
John Doe
Additional information about the payment method. For example, for EFT and credit card payments, will be a description with the last 4 digits of the account.
(ending in 1234)
Payment amount
55.45
Payments that have been scheduled for the future as a part of this cart. If no payments were scheduled, then this will be empty.
Line item id that this scheduled payment was created for. See line_items.
aaaaaaaa-2f3d-46b4-b524-c20ac6d06ef7
Date that this scheduled payment will be made on.
2017-10-12T00:00:00.0000000
Amount of scheduled payment
20.75
A list of line items that have been added to the cart
The line item ID.
307b94ae-fb6f-4382-b623-9b772ae07c83
The line item type. A description of each type is detailed in the table below.
| type | description |
|---|---|
| reg_fee | Registration Fee |
| question_fee | Question Fee |
| inst | Instance Fee |
reg_fee, question_fee, inst
The line item full description.
The line item short description.
The line item first-level grouping. This is only used for display purposes.
The line item second-level grouping. This is only used for display purposes.
The line item third-level grouping. This is only used for display purposes.
The line item fourth-level grouping. This is only used for display purposes.
The line item price per unit.
The line item quantity.
The price for all quantities. Equal to quantity * unit_price.
The date when the min_payment_amount is due.
The amount that will be paid by the payment method.
The balance amount due after discounts, system credits, and payment_amount that was scheduled for the future.
A list of discounts applied to the line item.
The type of discount applied. A description of each type is detailed in the table below.
| type | description |
|---|---|
| promo | Promo code |
| schol | Scholarship |
promo, schol
Dollar amount of discount
Discount description
The percentage amount
Information about customer
Customer phone number
Daxko Operations unit ID
Name of person who performed purchased_by
Email provided at checkout
Daxko Operations unit name
Address
Information about vendor
Name of vendor
My Branch
Address
Tax ID of vendor
Vendor phone number
{
"order_date": "2017-10-12T21:06:58.6460000Z",
"payments": [
{
"payment_method": "Bank Draft",
"name_on_account": "John Doe",
"description": "(ending in 5577)",
"amount": 20,
"scheduled_payments": [
{
"line_item_id": "aaaaaaaa-2f3d-46b4-b524-c20ac6d06ef7",
"date": "2017-10-12T00:00:00.0000000",
"amount": 90
},
{
"line_item_id": "bbbbbbbb-2f3d-46b4-b524-c20ac6d06ef7",
"date": "2017-11-12T00:00:00.0000000",
"amount": 75
}
]
}
],
"line_items": [
{
"line_item_id": "aaaaaaaa-2f3d-46b4-b524-c20ac6d06ef7",
"product_bundle_id": "4173b7d7-75f8-4735-86fd-ef2772cddb43",
"type": "inst",
"description": "(My Branch) My Program - My Session #1 - (10/12/17 - 10/19/17)",
"short_description": "10/12/17 - 10/19/17",
"due_date": "2017-10-12T00:00:00.0000000",
"level1": "John Doe",
"level2": "My Program",
"level3": "My Branch",
"level4": "My Session #1",
"unit_price": 100,
"quantity": 1,
"extended_price": 100,
"payment_amount": 10,
"scheduled_amount": 75,
"discounts": [
{
"type": "schol",
"amount": 15,
"percent": 0.15,
"description": "15% Programs Scholarship"
}
]
},
{
"line_item_id": "bbbbbbbb-2f3d-46b4-b524-c20ac6d06ef7",
"product_bundle_id": "4173b7d7-75f8-4735-86fd-ef2772cddb43",
"type": "inst",
"description": "(My Branch) My Program - My Session #1 - (11/12/17 - 11/19/17)",
"short_description": "11/12/17 - 11/19/17",
"due_date": "2017-11-12T00:00:00.0000000",
"level1": "John Doe",
"level2": "My Program",
"level3": "My Branch",
"level4": "My Session #1",
"unit_price": 100,
"quantity": 1,
"extended_price": 100,
"payment_amount": 10,
"scheduled_amount": 90,
"discounts": []
}
],
"customer": {
"phone": "(999) 123-4567",
"unit_id": "300181454",
"purchased_by": "John Doe",
"email": "john.doe@example.org",
"name": "Doe, John",
"address": {
"line1": "123 Some Dr.",
"line2": "",
"city": "Beverly Hills",
"state": "CA",
"zip": "90210",
"country": "US"
}
},
"vendor": {
"name": "My Branch",
"address": {
"line1": "555 My Branch Dr.",
"line2": "",
"city": "Beverly Hills",
"state": "CA",
"zip": "90210",
"country": "US"
},
"footer": "FOR YOUTH DEVELOPMENT FOR HEALTHY LIVING FOR SOCIAL RESPONSIBILITY",
"tax_id": "111112222",
"phone": "(999) 555-5555"
}
}
Members
The Member API retrieves member data in the context of the specific members.
Search for members
Description
Searches for members based on the provided filters. A maximum of 100 members will be returned.
Query Parameters
The member's first name. If this is provided, the member's last name must also be provided.
AtticusThe member's last name.
FinchThe member's barcode.
12345-AThe member's home phone number. Please note that, when using this field in conjunction with the member's name or barcode, the returned results will emcompass any members that match either the phone number or any of those two fields.
(555) 555-5555The member's email address.
atticus.finch@example.comThe member's home-branch ID.
B73The member's membership type ID.
MT61Whether to only return active members.
trueThe member's preferred name.
AlResponses
HTTP 200 OK
The total number or results returned.
1
The results found.
Indicates if the member has an active membership
true
The barcode value that is encoded by the member's membership card
123543-01
The member's date of birth
1920-05-11T00:00:00+0000
A list of member addresses
The type of email
default
default
The member's email address
atticus.finch@example.com
The member's gender
Standard format for gender type
M
M, F
User-friendly name of gender
Male
Male, Female
The member's designated home location
The ID of the location
B144
The type of the location
branch
branch
The name of the location
Downtown Maycomb
The date the member first joined
1947-05-11T00:00:00+0000
The member's ID
143343-01
The member's membership type
Active Attorneys Level
The member's unit ID
132243
The member's name
The member's prefix
Mr.
The member's first name
Atticus
The member's middle name
H
The member's last name
Finch
The member's suffix
Esq.
The member's preferred name
Al
A list of member phone numbers
The type of phone number
Home
home, mobile, emergency
The phone full number
(555) 555-5555
The SMS texting status of the phone number
Unverified
Get member details
Description
Retrieves detailed information about a specific member.
Path Parameters
The ID of the member
Responses
HTTP 200 OK
Indicates whether the member has an active membership
A list of member addresses
The type of address
home
The first street part of the address
The second street part of the address
The city of the address
The state of the address
The zip code of the address
The country of the address
The barcode value that is encoded by the member's membership card
The member's date of birth
A list of member addresses
The type of email
default
A member's email address
The member's gender
Standard format for gender type
M, F
User-friendly name of gender
Male, Female
The member's addition gender identity
The member's designated home location
The ID of the location
The type of the location
branch
The name of the location
The date the member first joined
The member's ID
The member's membership type
The member's unit ID
The date the member last joined
The member's name
The member's name prefix
The member's first name
The member's middle name
The member's last name
The member's name suffix
The member's preferred name
A list of member phone numbers
The type of phone number
home, mobile, emergency
The area code or prefix of the phone number
The phone number
The extension of the phone number
A list of member photos
The URL of the member photo
The type of member photo
thumbnail, regular
The prefix for the member.
The suffix for the member.
When the member was added, in the branch’s local time.
When the member’s membership was last canceled or terminated, in the branch’s local time.
The ID of member health screening status (available if client feature is enabled).
cleared
cleared, not_cleared
The expiry date of member health screening (available if client feature is enabled).
2022-07-21T00:00:00.0000000
Update member details
Description
Updates the specified member's profile.
Path Parameters
The ID of the member
123424-24Request Body
A list of member addresses to update.
The type of address
home
home
The first street part of the address
123 Elm. St.
The second street part of the address
Apt. 124
The city of the address
Maycomb
The state of the address
AL
The Zip code of the address
36123
The country of the address
USA
The member's date of birth
1920-12-31
A list of member addresses to be updated.
The type of email
default
A member's email address
boo.radley@example.com
The member's gender
Standard format for gender member_type
M
M, F
The member's name
The member's name prefix
Mr.
Mr., Ms., Mrs., Miss, Dr., Rev., Rab., Can., Hon.
The member's first name
Boo
The member's middle name
M
The member's last name
Radley
The members' name suffix
Sr.
Jr., Sr., I, II, III, IV, V
A list of member phone numbers to update
The type of phone number
home
home, mobile, emergency
The area code or prefix of the phone number
555
The phone number
555-5555
The extension of the phone number
Ext. 514
Responses
HTTP 204 No content
Update member type
Description
Update a member to adult, child or set as primary.
Path Parameters
The ID of the member.
4723647872-01Request Body
The member type the member should be updated to.
adult, child, primary
Responses
HTTP 204 No content
Get member relationships
Description
Retrieves relationships for a member.
For example, if Robert is Susie's grandfather, then Susie would be listed in Robert's relationships with relationship, indicating Robert's relationship to Susie and whether Robert is authorized as a pickup for Susie.
Path Parameters
The ID of the member.
4723647872-01Query Parameters
If provided, it will filter the results to only those for whom the member is designated as an authorized pickup.
true, false
When provided, the query will filter to only the relationships for the provided ID.
The relationship_type_id should be a valid ID from list-relationship types
REL160Responses
HTTP 200 OK
The member's name.
The member's first name.
Steve
The member's last name.
Rogers
The source ID of the member.
RELMEM1234567
The member's unit ID.
4723647872
The member's membership type
Adult
The relationships associated with the member.
Id of the relationship.
RELMEM3
The ID of the related member.
4723647872-02
The name of the related member.
The first name of the related member.
Bruce
The last name of the related member.
Banner
Contact information of the related member.
The phone of the related member.
(555) 555-5555
The email of the related member.
bruce.banner@example.com
The ID of the relationship type.
REL160
The name of the relationship type.
friend
Whether the member is an authorized pickup for the related member.
false
Get member online account
Description
Retrieves the username of a member.
Path Parameters
The ID of the member
Responses
HTTP 200 OK
The member's username
jdoe
Get member notes
Description
Retrieves a list of all notes for a member.
Path Parameters
The ID of the member.
300180263-02Query Parameters
A comma-separated list of categories of notes to be fetched. If not provided, then all the notes for a member will be fetched. You may use the get-member-note-types endpoint for retrieving a list of all categories.
AllGeneral,Bad DebtResponses
HTTP 200 OK
The total number of notes.
1
A list of notes.
The ID of the note.
2086610
The timestamp (in UTC) when the note was created.
2020-10-06T12:22:46.0930000
The name of the member.
Quinata, Isabella
The message of the note.
This is a new note
The category of the note.
General
The name of the employee who created the note.
Steven Williams
The start date for displaying the note.
2020-06-16
The end date for displaying the note.
2020-06-20
Whether the note is active.
true
Add member note
Description
Add a note to a member's account.
Path Parameters
The ID of the member
Request Body
The type of note
Volunteer
Affiliations, Aquatics, Bad Debt, Behavior, Billing, Childcare, Employment, Financial Assistance, General, Guest Passes, Impact Driver, Interests, Legacy Data, Medical, Membership, NPS, Staff Action, Volunteer
The content of the note
This is the greatest note in the history of notes, so says I.
The name of the note's author
Yours truly
The start date for displaying the note
2020-06-16
The end date for displaying the note
2020-06-20
Responses
HTTP 200 OK
Whether the operation succeeded
true
Get my member info
Description
Retrieves basic information about a member using a member scoped access_token. See Member Authentication Tutorial
Responses
HTTP 200 OK
The member's ID
The member's unit ID
The member's name
The member's first name
The member's last name
The member's preferred name
List Member Types
Description
Retrieves a list of all member types
Responses
HTTP 200 OK
A list of member types
The ID of the member type
The name of the member type
Member Check-ins
Description
Retrieves a list of check-ins for a specified member along with the location where the check-in occurred. You must specify a custom time frame
to retrieve check-ins with the start_date and end_date query parameters.
For example, GET /members/9999-99/check_ins?start_date=2017-03-02T00:00:00Z&end_date=2017-03-03T00:00:00Z would return
the check-ins for member 9999-99 from midnight March 2, 2017 (UTC time) to midnight March 3, 2017 (UTC time).
Path Parameters
The ID of the member returned from the /member/login endpoint.
Query Parameters
The start date in UTC time (ISO 8601 format).
The end date in UTC time (ISO 8601 format).
Responses
HTTP 200 OK
The location identifier.
The location type.
branch
The name of the location.
1
Get member registrations
Description
Get the programs a member has attended or has registered for.
Path Parameters
The ID of the member.
300180543-01Query Parameters
The start of the date range.
2020/01/20The end of the date range.
2020/12/31The type of program by which to filter the query.
child_carestandard, package, child_care, camp
When paginating over the results, the page number over which to iterate results.
11The number of results to be returned.
2525Whether to return all of the registrations for member's unit.
falsetrueResponses
HTTP 200 OK
The list of registrations for the member.
The ID of the program.
CMP4245231
The name of the program.
Underwater basket-weaving
The type of program.
camp
standard, package, child_care, camp
The ID of the program offering.
CI4246705
The name of the program offering.
Advanced weeklong summer session
The ID of the branch or site for the activity.
B38
The name of the location
Downtown branch
The instance details (available only if program_type is either child_care or camp).
The start date of the program offering.
01/01/2020
The end date of the program offering.
12/31/2020
The days of the week registered for.
"[ Monday, Tuesday, Friday ]"
The list of instances in the program offering.
The start date of the instance.
01/01/2020
The end date of the instance.
12/31/2020
Whether the member is on waiting list for the given instance.
The segment details (available only if program_type is standard).
The start date of the program offering.
01/01/2020
The end date of the program offering.
12/31/2020
The start time of set for the session.
05:00
The end time of set for the session.
07:00
The days of the week set for the session.
"[ Monday, Tuesday, Friday ]"
The list of segments in the program offering.
The start date of the segment.
01/01/2020
The start date of the segment.
12/31/2020
Whether the member is on the waiting list for the current segment.
The session details (available only if program_type is package).
The number of sessions redeemed.
3
The number of sessions remaining.
7
The total number of sessions.
10
The duration of each session, in minutes.
60
The expiration date of the session.
12/31/2020
The name of the default instructor for the session.
Joe Smith.
Whether the offering is completed (e.g., whether all sessions have been redeemed or it is too late to redeem them).
The list of redeemed sessions.
The date on which this session was redeemed.
12/01/2020
The instructor name with which the session was redeemed.
Navdeep Singh
The total number of registrations returned.
1
Whether there are more records available to be queried.
{
"registrations": [
{
"program_id": "PP63336",
"program_name": "Pgm PAckage",
"program_type": "package",
"offering_id": "PKG922829",
"offering_name": "package 2",
"location_id": "B38",
"location_name": "YMCA - South Hampton Roads Branch",
"session_details": {
"redeemed_instances": 3,
"remaining_instances": 7,
"total_instances": 10,
"duration": 60,
"expiration_date": "11/26/2020",
"instructor_name": "Navdeep Rana",
"is_completed": false,
"redeemed_sessions": [
{
"redeemed_date": "05/26/2020",
"instructor_name": "Navdeep Rana"
},
{
"redeemed_date": "05/27/2020",
"instructor_name": "Navdeep Rana"
},
{
"redeemed_date": "05/27/2020",
"instructor_name": "Caleb Tucker"
}
]
}
},
{
"program_id": "CC4245230",
"program_name": "AA CC Pgm",
"program_type": "child_care",
"offering_id": "RP4223246",
"offering_name": "AA CC RatePlan",
"location_id": "B38",
"location_name": "YMCA - South Hampton Roads Branch",
"instance_details": {
"start_date": "01/01/2020",
"end_date": "12/31/2020",
"days_of_the_week": [
"Wednesday",
"Friday",
"Sunday"
],
"instances": [
{
"start_date": "01/01/2020",
"end_date": "12/31/2020",
"is_on_waitling_list": true
}
]
}
},
{
"program_id": "TMP63334",
"program_name": "Standard Pgm",
"program_type": "standard",
"offering_id": "SES922827",
"offering_name": "Standard Pgm Session 2",
"location_id": "B38",
"location_name": "YMCA - South Hampton Roads Branch",
"segment_details": {
"start_date": "01/01/2020",
"end_date": "12/31/2020",
"start_time": "16:00",
"end_time": "18:00",
"days_of_the_week": [
"Wednesday",
"Friday",
"Sunday"
],
"segments": [
{
"start_date": "01/01/2020",
"end_date": "06/30/2020",
"is_on_waitling_list": false
}
]
}
}
],
"total": 3,
"has_more_records": false
}
Get member alerts
Description
Retrieves a list of all alerts for a member.
Note that, if neither start_date and end_date are provided, only active alerts will be listed.
Path Parameters
The ID of the member.
300180263-02Query Parameters
Optionally, whether to filter the alerts to those being displayed after the provided date.
2020-10-11Optionally, whether to filter the alerts those those being displayed before the provided date.
2020-10-30Responses
HTTP 200 OK
The total number of alerts.
1
A list of alerts.
The ID of the alert.
2086610
The timestamp (in UTC) when the alert was created.
2020-10-06T12:22:46.0930000
The name of the member.
Quinata, Isabella
The message of the alert.
This is a new alert
The name of the admin who created the alert.
Steven Williams
The start date for displaying the alert.
2020-06-16
The end date for displaying the alert.
2020-06-20
The priority of the alert.
Medium
Low, Medium, High
Whether to show the alert at the unit level.
false
Whether to remove the alert after the first check-in.
true
Whether to show the alert for everyone upon check-in.
false
Whether the alert is active now.
true
Create member alert
Description
Creates a new alert for a member.
Path Parameters
The ID of the member.
300180263-02Request Body
The content/message of the alert.
This is a new alert
The priority of the alert.
Medium
Low, Medium, High
The start date for displaying the alert.
2020-06-16
The end date for displaying the alert.
2020-06-20
Whether to show the alert for all member of the unit.
false
false
Whether to remove the alert after the first check-in.
false
true
Whether to show the alert for everyone upon check-in.
false
false
Responses
HTTP 201 Created
The ID of the alert created.
2086623
Get member alert by ID
Description
Retrieves the details of a member alert.
Path Parameters
The ID of the member.
300180263-02The ID of the alert.
2086611Responses
HTTP 200 OK
The ID of the alert.
2086610
The timestamp (in UTC) when the alert was created.
2020-10-06T12:22:46.0930000
The name of the member.
Quinata, Isabella
The message of the alert.
This is a new alert
The name of the admin who created the alert.
Steven Williams
The start date for displaying the alert.
2020-06-16
The end date for displaying the alert.
2020-06-20
The priority of the alert.
Medium
Low, Medium, High
Whether to show the alert at the unit level.
false
Whether to remove the alert after the first check-in.
true
Whether to show the alert for everyone upon check-in.
false
Whether the alert is active now.
true
Update member alert by ID
Description
Updates the details of a member alert. The fields which are not provided in the request body are not updated.
Path Parameters
The ID of the member.
300180263-02The ID of the alert.
2086611Request Body
The new content/message of the alert.
This is an edited alert
The new priority of the alert.
Medium
Low, Medium, High
The new start date for displaying the alert.
2020-06-16
The new end date for displaying the alert.
2020-06-20
Whether to set the end_date to null.
false
true
Whether to show the alert for all members in the unit.
false
Whether to remove the alert after the first check-in.
true
Whether to show the alert for everyone upon check-in.
false
Responses
HTTP 204 No Content
Delete member alert by ID
Description
Deletes a member's alert.
Path Parameters
The ID of the member.
300180263-02The ID of the alert.
2086611Responses
HTTP 204 No Content
Get member-note types
Description
Retrieves a list of categories for member notes.
Responses
HTTP 200 OK
The total number of note types.
7
A list of types.
["Medical","General","Behavior","Interests","Childcare","Financial Assistance","Aquatics"]
Get member note
Description
Retrieves the details of a member note.
Path Parameters
The ID of the member.
300180263-02The ID of the note.
2086611Responses
HTTP 200 OK
The ID of the note.
2086610
The timestamp (in UTC) when the note was created.
2020-10-06T12:22:46.0930000
The name of the member.
Quinata, Isabella
The message of the note.
This is a new note
The category of the note.
General
The name of the employee who created the note.
Steven Williams
The start date for displaying the note.
2020-06-16
The end date for displaying the note.
2020-06-20
Whether the note is active.
true
Delete member note
Description
Deletes a member's note.
Path Parameters
The ID of the member.
300180263-02The ID of the note.
2086611Responses
HTTP 204 No Content
Get the member interest questions
Description
Get the custom member questions related to member interests
Path Parameters
The ID of the member.
300180543-01Responses
HTTP 200 OK
The list of member interest questions.
The key of the member interest question.
interest1
The detailed information related to the custom member question.
The data-type of custom member question.
The display name of custom member question.
Areas of Interest
Whether it is a required member question.
Whether it is a read-only member question.
The list accepted answers for this member question.
The id of the answer to be passed in as an answer.
1
The text value of the answer.
Strength Training
What should be displayed to the member.
Strength Training
The list possbile answer IDs that the member has selected for this question.
"[ '32', '64' ]"
Update member interest question answers
Description
Update the member's interest question(s) selected answer(s)
Path Parameters
The ID of the member.
300180543-01The key of the member interest question being updated.
interest1Request Body
The new possbile answer IDs to save for the member.
"[ 32, 64 ]"
Responses
HTTP 200 OK
Whether the update was successful.
Why the update was not successful.
Get all member photos
Description
Retrieves a list of all the photos for members.
Query Parameters
A date time value that can be used to only retrieve member photos updated after a certain date. This can be used to avoid returning and paging through all result if just looking for the most recent updates. Not including this will return all member photos. The date time value is in Central Time
Wed Dec 05 2018 09:58:32 GMT-0600 (Central Standard Time)This parameter is used as a cursor to fetch the next page of results. Use
the after value from a previously returned response body
View the Paging section of the Getting Started Tutorial for more information.
c2FtcGxlIG5hbWUsb2ZmZXJpbmcjOTk5OS1DQzEyMzQtUlA1Njc4The number of items to return in a single response. The maximum value is 1000.
1000Responses
HTTP 200 OK
The total number of items available for this query.
The maximum number of items requested.
A pagination cursor to use when fetching the next page of results. This value will be omitted if the response contains the last page of results. View the Paging section of the Getting Started Tutorial for more information.
c2FtcGxlIG5hbWUsb2ZmZXJpbmcjOTk5OS1DQzEyMzQtUlA1Njc4
A list of member info and photos
The ID of the member
A list of the member's photos
The URL of the member photo
The type of member photo
thumbnail, regular
The date and time the member's photo was last updated
Membership
The Membership API allows members to join or renew at a branch.
List membership branches
Description
This endpoint returns a list of branches that can handle membership join.
Query Parameters
Restricts the list of branches to only be associated with in-house or online membership join.
onlineonlinein_house, online
When true, the renew parameter restricts the list of branches to
only include branches that allow members to renew their membership.
When false, the renew parameter does not restrict the list of branches.
falsetrueResponses
HTTP 200 OK
The list of branches that allow members to join via the API
The branch ID
B32
The branch name
South Hampton
List rate questions
Description
This endpoint returns a list of membership rate questions.
Responses
HTTP 200 OK
The list of rate questions
The Rate Question ID
RQ1234
The Rate Question name
Please indicate your Annual Household Income?
The order in which rate question will be listed
1
The Rate Question Answer ID
RA5678
The Related/Parent Rate Question ID
RQ1234
The Rate Question Answer ID answer
$60,000 - $64,999
The order in which rate question will be listed
1
{
"rate_questions": [
{
"question_id": "RQ1234",
"name": "Please indicate your Annual Household Income?",
"display_order": 1,
"possible_answers": [
{
"answer_id": "RA5678",
"question_id": "RQ1234",
"value": "$60,000 - $64,999",
"display_order": 1
},
"..."
]
}
]
}
List discount groups
Description
This endpoint returns a list of membership discount groups.
Query Parameters
Restricts the list of discount groups to a particular branch.
B32Restricts the list of discount groups to only include membership types associated with in-house or online membership join.
onlineonlinein_house, online
Responses
HTTP 200 OK
The list of discount groups
The discount group ID
DG5982
The discount group name
Armed Services Members
The discount group description
A 20 percent discount for members of our military.
Indicates if the promotion is enabled for the registration type
true
The discount group promo code
WELCOME
The promotion availability start date, won't be set if the promotion runs indefinitely
2022-08-01T00:00:00.0000000
The promotion availability end date, won't be set if the promotion runs indefinitely
2022-09-01T00:00:00.0000000
The membership type ID
MT9212
The membership type description
Family Membership
The original membership join fee amount, prior to discount
50
The amount discounted from the original membership join fee amount
25
The original membership rate amount, prior to discount
75
The amount discounted from the original membership rate
40
The membership rate subsidy amount
1
Indicates if this discount group requires approval
true
Indicates how long the discount group applies after the member joins or renews.
3
{
"discount_groups": [
{
"id": "DG22412",
"name": "Armed Services Members",
"promotion_enabled": true,
"promotion_code": "WELCOME",
"promotion_start_date": "2022-08-17T00:00:00.0000000",
"promotion_end_date": "2022-08-31T00:00:00.0000000",
"membership_types": [
{
"id": "MT2891",
"expires_in_month": 3,
"join_fee_original": 50,
"join_fee_discount": 25,
"name": "Family Membership",
"rate_original": 75,
"rate_discount": 40,
"rate_subsidy": 0,
"requires_approval": true
},
"..."
]
},
"..."
]
}
List membership types
Description
This endpoint returns a list of membership types.
Query Parameters
Restricts the list of membership types to a particular branch.
B32Allows the supplied discount group ids to be applied to the fees for the membership type (if the discount is applicable to the membership type).
DG123,DG456Allows the supplied rate questions answer ids' related discount group ids to be applied to the fees for the membership type (if the discount is applicable to the membership type).
RA123,RA456Restricts the list of membership types to only be associated with in-house or online membership join.
onlineonlinein_house, online
Whether to show inactive membership types.
falsetrueResponses
HTTP 200 OK
The list of membership types
The membership type ID
MT512
The membership type name
Family
The membership type description
A membership for the whole family
The term description
Monthly
The number of months associated with the term
1
Indicates if the fee will be prorated to the draft day
true
Number of months the join fee will be equally spread across
1
Indicates if this membership type will auto renew
true
Indicates if this membership type allows discounts
true
If is_auto_renew equals true, this is the date of the month for drafting, otherwise it does not apply
28
Indicates if a prorated fee will be rounded to the nearest dollar
true
The type of the fee
membership_fee
The fee name
Membership Due
The fee amount
400
Indicates if sales tax applies to this fee
true
The discount group ID
DG977
The discount group name
COA
Inidicates if this discount is a discount or subsidy
discount
This discount original_amount
75
This is how much of the original_amount was able to be applied to the associated fee
75
Detail tax info for this discount group
tax amount
2.56
tax name
Sales Tax
tax rate
0.0560
Detail tax info for this fee
tax amount
2.56
tax name
Sales Tax
tax rate
0.0560
[
{
"id": "MT507",
"name": "Family",
"term": {
"description": "Monthly",
"months_in_term": 1
},
"is_prorated_to_draft_day": true,
"join_fee_spread_over_month": 1,
"is_auto_renew": true,
"is_discount_allowed": true,
"online_draft_day": 28,
"prorate_fee_round_to_dollar": false,
"fees": [
{
"type": "join_fee",
"name": "Join Fee",
"amount": 75,
"sales_tax_applies": false,
"discounts": []
},
{
"type": "membership_fee",
"name": "Membership Due",
"amount": 83,
"sales_tax_applies": false,
"discounts": [
{
"id": "DG2306",
"name": "Gateway Bank Senior Management",
"type": "subsidy",
"original_amount": 82,
"applied_amount": 82
},
"..."
]
}
]
}
]
List member rates
Description
This endpoint returns a list of member rates (member rate clients only).
Query Parameters
Restricts the list of member rates to a particular branch.
B32Restricts the list of membe rates to only be associated with in-house or online membership join.
onlineonlinein_house, online
Responses
HTTP 200 OK
The list of member rates
The member rate id
MR1234
The member rate name
My Member Rate
The member rate description
A yearly membership
one-time
one-time, monthly
Member rate amount
100.00
adult
adult, child
{
"member_rates": [
{
"id": "MR1105",
"name": "My Test Membership",
"description": "This is my description to show up.",
"frequency": "one-time",
"amount": 100,
"member_type": "child"
},
{
"id": "MR1106",
"name": "My Test Membership",
"description": "This is my description to show up.",
"frequency": "monthly",
"amount": 10,
"member_type": "child"
}
]
}
List age groups
Description
This lists out age groups set up by the client. If the client has not set up explicit age groups (see Membership : Settings : Age Groups in
Daxko Operations), then this will return the any_adult and any_child as the only results. The value any_adult or any_child may be used in place of
any call that requires age_group_id as an input parameter if you do not with to be forced to use the granual age groups set up by the client.
Responses
HTTP 200 OK
List of age groups
The age group ID
CDAG1111
The age group name
Youth
Minimum age (inclusive) of this age group
1
Maximum age (inclusive) of this age group
18
Description of this age group
18 and under
This groups the age groups into either a child or adult bucket if explicit age groups are set up by the client. You may use this value in place of any calls that require age group id if you do not want to get too granular.
any_child
any_adult, any_child
{
"age_groups": [
{
"id": "CDAG1111",
"name": "Youth",
"min_age": 0,
"max_age": 12,
"description": "12 and under",
"category": "any_child"
},
{
"id": "CDAG2222",
"name": "Teen",
"min_age": 13,
"max_age": 20,
"description": "13-20",
"category": "any_adult"
},
{
"id": "CDAG3333",
"name": "Adult",
"min_age": 21,
"max_age": 64,
"description": "21-64",
"category": "any_adult"
},
{
"id": "CDAG4444",
"name": "Senior",
"min_age": 65,
"max_age": 999,
"description": "65+",
"category": "any_adult"
}
]
}
Start join process
Description
Starts the join process. The returned cart_id will be required on subsequent calls to build up the membership.
Request Body
Membership type id to start join process with. (required for unit rate customers)
MT1234
Branch id to start join process with. (required for member rate customers)
B1234
Sets the context of the registration
online
online
online, in_house
Responses
HTTP 201 Created
The ID of the cart that was created. Use this ID for any membership API calls that
require the cart_id as a path parameter. NOTE: This cart_id is only valid for membership API calls and cannot be used for any program registration API calls.
db2c4395-888c-42ce-9056-08e2f8a5f2d0
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
{
"cart_id": "db2c4395-888c-42ce-9056-08e2f8a5f2d0",
"links": [
{
"rel": "review",
"href": "/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0"
}
]
}
Start renewal process
Description
Starts the renewal process for a given membership_type_id and unit_id. The returned cart_id will be required on subsequent calls to build up the membership.
A renewal is signing up a unit that already has an account but is inactive. If you try to start a renewal for a unit that is already active, then you will get an error.
Once all changes are complete, use the Checkout API to finalize the changes.
Request Body
Membership type id to start renewal process with.
MT1234
Unit ID to renew
3434334
Sets the context of the registration
online
online
online, in_house
Responses
HTTP 201 Created
The ID of the cart that was created. Use this ID for any membership API calls that
require the cart_id as a path parameter. NOTE: This cart_id is only valid for membership API calls and cannot be used for any program registration API calls.
db2c4395-888c-42ce-9056-08e2f8a5f2d0
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
{
"cart_id": "db2c4395-888c-42ce-9056-08e2f8a5f2d0",
"links": [
{
"rel": "review",
"href": "/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0"
}
]
}
Validate email
Description
Validates email address against other members in the system and also other members that are currently in the cart.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
Email address to Validate
member.name@daxko.com
GUID of member to exclude from duplicate check. For example, if you are editing a member in the cart, you would pass the GUID of that member to this parameter to exclude that member in the cart from the duplicate check.
66ae13b3-c645-4bca-bb01-d8845ecd879a
Responses
HTTP 200 OK
Value is always true when 200 OK is returned.
true
Message giving more detail on success of validation
Email is valid
HTTP 409 Conflict (this response returns when the email is used by another member)
Value is always false when 409 Conflict is returned.
false
Message giving more detail on failure of validation.
This ID is used by another member
If success is false, then this will be the member id of the member with the given email address.
67433223455-01
If success is false, then this will be the unit id of the member with the given email address.
67433223455
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
Get member questions
Description
Gets member questions so that you can know which answers to provide when adding a new member
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aQuery Parameters
The age group of the member being added. This can be any of the following:
any_child, any_adult or a specific age group id such as CDAG1111 that is
returned from the List Age Groups api call. This is required
because the member must be marked as an adult or child in the system (there currently is not
a feature in Daxko Operations to automatically assign based on age)
any_adultResponses
HTTP 200 OK
This is a dictionary where the question ID is the key mapping to an object that defines the question.
"questions": {
"name": {
"title": "Name",
...
},
"address": {
"title": "Address",
...
},
...
}
Type of question
section, text, name, date, dropdown, radio, checkboxes, phone, address, email
Question title
Name
Question description/additional instructions.
Please fill first name first
Value is true if an answer to the question is required.
true
Value is true if the question should be rendered in the UI as read only.
true
Maximum text length allowed for questions of type text and email.
22
Default value. Exists only for questions of type dropdown, checkboxes, and radio.
Selected
List of possible answers. Exists only for questions of type dropdown, checkboxes, and radio.
Possible answer ID
childcare_possible_answer-103476
Possible answer value
Medium
Fee amount for this answer. Exists only when there is a fee.
10.00
Display friendly value.
Medium - $10.00
Value is true if the UI should not show an empty option. For example, the dropdown might by default say 'Select One', but if this value is true then 'Select One' should not be shown.
true
Defines what is considered an empty value for this question. For example, the value 'U' might be considered an empty value and will throw a validation error if this value is selected. Exists only for questions of type dropdown, checkboxes, and radio.
U
Regular expression to validate input against. Exists only for questions of type email.
^\d+$
Value is true if phone extension number should be rendered in UI. Exists only for questions of type phone.
true
Value is true if this is an international address or phone number question. Exists only for questions of type phone and address.
true
Value is true if first name should be rendered in UI. Exists only for questions of type name.
true
Value is true if middle name should be rendered in UI. Exists only for questions of type name.
true
Value is true if last name should be rendered in UI. Exists only for questions of type name.
true
Value is true if name prefix should be rendered in UI. Exists only for questions of type name.
true
Value is true if name suffix should be rendered in UI. Exists only for questions of type name.
true
Value is true if first name is required. Exists only for questions of type name.
true
Value is true if middle name is required. Exists only for questions of type name.
true
Value is true if last name is required. Exists only for questions of type name.
true
List of available name prefixes.
ID of prefix
Mr.
Display value of prefix
Mr.
List of available name suffixes.
ID of suffix
Jr.
Display value of suffix
Jr.
Canada province list. Exists only for questions of type address when intl is true.
Province code
AB
Display name of province
British Columbia
Country list. Exists only for questions of type address when intl is true.
Country code
US
Display name of province
Canada
This is a dictionary where the question ID is the key mapping to an object that defines the answer to that question. Any values
that are returned are default values to use in your UI. In the case of race question, to read only 1 race for a member, use race key and to read more than 1 races for a member, use race_multi key.
"answers": {
"name": "answer text...",
"address": {
"line1": "111 Some Dr.",
"city": "Hollywood",
"state": "CA",
"zip": "90210"
},
...
}
Add member to cart
Description
Adds a member to the cart.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aQuery Parameters
The age group of the member being added. This can be any of the following:
any_child, any_adult or a specific age group id such as CDAG1111 that is
returned from the List Age Groups api call. This is required
because the member must be marked as an adult or child in the system (there currently is not
a feature in Daxko Operations to automatically assign based on age)
any_adult(member rate clients only) The member rate to use for this member. If you omit this parameter, then the member will use the Inactive Adult or Inactive Child member rate (depending on the age_group_id used)
MR1234Request Body
Member's name
Steven
Gary
Williams
Member's email
steve@daxko.com
Member's gender. Use U for unknown or unspecified.
M
M, F, U
Member's birth date
2020-02-23
Member's address
South Avenue
Baker St.
San Jose
California
94233
US
Member's phone number
(555) 234-3433
Member's race. Use the values provided from the Get member questions API call. To save more than 1 races for a member, add comma separated race values in this key.
Hispanic
(Unit rate clients only) Emergency contact's name
Cal
El
(Unit rate clients only) Emergency contact's phone number
(555) 234-4543
Member's Password
- Must be at least 7 characters.
- Must contain at least 1 lowercase letter.
- Must contain at least 1 uppercase letter.
- Must contain at least 1 numeric character.
456544$$
456544$$
(Member rate clients only when adding a child) Do any of your kids qualify for free or reduced-price lunches at school?
True
True, False
(Member rate clients only when adding a child) Are you part of a single parent household??
True
True, False
(Member rate clients only when adding a child) Has anyone in your household served in the military?
True
True, False
Responses
HTTP 201 Created
The ID of the current cart. Use this ID for any cart API calls that
require the cart_id as a path parameter.
4762338e-835f-48e4-b5bc-a928c6c76c5a
The GUID of the member that will be used to reference the member in this cart. Once the checkout is complete, this GUID will no longer be used to reference a member.
549866ea-882b-4c9c-92b4-7e6dd4ffcb28
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
{
"cart_id": "4762338e-835f-48e4-b5bc-a928c6c76c5a",
"links": [
{
"rel": "review",
"href": "/membership/4762338e-835f-48e4-b5bc-a928c6c76c5a"
},
{
"rel": "member",
"href": "/membership/4762338e-835f-48e4-b5bc-a928c6c76c5a/members/549866ea-882b-4c9c-92b4-7e6dd4ffcb28"
}
],
"member_guid": "549866ea-882b-4c9c-92b4-7e6dd4ffcb28"
}
Delete member in cart
Description
Deletes a member in the cart.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
A list of the member GUIDs to be removed
Responses
HTTP 200 OK
Value is true when delete was successful
true
Get member in cart
Description
Gets a member in the cart based on temporary GUID
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aThe temporary GUID of the member.
88ae13b3-e645-abca-7b01-d8755ecd87ffResponses
HTTP 200 OK
This is a dictionary where the question ID is the key mapping to an object that defines the question.
"questions": {
"name": {
"title": "Name",
...
},
"address": {
"title": "Address",
...
},
...
}
Type of question
section, text, name, date, dropdown, radio, checkboxes, phone, address, email
Question title
Name
Question description/additional instructions.
Please fill first name first
Value is true if an answer to the question is required.
true
Value is true if the question should be rendered in the UI as read only.
true
Maximum text length allowed for questions of type text and email.
22
Default value. Exists only for questions of type dropdown, checkboxes, and radio.
Selected
List of possible answers. Exists only for questions of type dropdown, checkboxes, and radio.
Possible answer ID
childcare_possible_answer-103476
Possible answer value
Medium
Fee amount for this answer. Exists only when there is a fee.
10.00
Display friendly value.
Medium - $10.00
Value is true if the UI should not show an empty option. For example, the dropdown might by default say 'Select One', but if this value is true then 'Select One' should not be shown.
true
Defines what is considered an empty value for this question. For example, the value 'U' might be considered an empty value and will throw a validation error if this value is selected. Exists only for questions of type dropdown, checkboxes, and radio.
U
Regular expression to validate input against. Exists only for questions of type email.
^\d+$
Value is true if phone extension number should be rendered in UI. Exists only for questions of type phone.
true
Value is true if this is an international address or phone number question. Exists only for questions of type phone and address.
true
Value is true if first name should be rendered in UI. Exists only for questions of type name.
true
Value is true if middle name should be rendered in UI. Exists only for questions of type name.
true
Value is true if last name should be rendered in UI. Exists only for questions of type name.
true
Value is true if name prefix should be rendered in UI. Exists only for questions of type name.
true
Value is true if name suffix should be rendered in UI. Exists only for questions of type name.
true
Value is true if first name is required. Exists only for questions of type name.
true
Value is true if middle name is required. Exists only for questions of type name.
true
Value is true if last name is required. Exists only for questions of type name.
true
List of available name prefixes.
ID of prefix
Mr.
Display value of prefix
Mr.
List of available name suffixes.
ID of suffix
Jr.
Display value of suffix
Jr.
Canada province list. Exists only for questions of type address when intl is true.
Province code
AB
Display name of province
British Columbia
Country list. Exists only for questions of type address when intl is true.
Country code
US
Display name of province
Canada
This is a dictionary where the question ID is the key mapping to an object that defines the answer to that question.
In the case of race question, to read only 1 race for a member, use race key and to read more than 1 races for a member, use race_multi key.
"answers": {
"name": "answer text...",
"address": {
"line1": "111 Some Dr.",
...
},
...
}
Update member in cart
Description
Updates a member in the cart.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aThe temporary GUID of the member.
88ae13b3-e645-abca-7b01-d8755ecd87ffRequest Body
Member's name
Steven
Gary
Williams
Member's email
steve@daxko.com
Member's gender. Use U for unknown or unspecified.
M
M, F, U
Member's birth date
2020-02-23
Member's address
South Avenue
Baker St.
San Jose
California
94233
US
Member's phone number
(555) 234-3433
Member's race. Use the values provided from the Get member questions API call. To save more than 1 races for a member, add comma separated race values in this key.
Hispanic
(Unit rate clients only) Emergency contact's name
Cal
El
(Unit rate clients only) Emergency contact's phone number
(555) 234-4543
Member's Password
- Must be at least 7 characters.
- Must contain at least 1 lowercase letter.
- Must contain at least 1 uppercase letter.
- Must contain at least 1 numeric character.
456544$$
456544$$
(Member rate clients only when adding a child) Do any of your kids qualify for free or reduced-price lunches at school?
True
True, False
(Member rate clients only when adding a child) Are you part of a single parent household??
True
True, False
(Member rate clients only when adding a child) Has anyone in your household served in the military?
True
True, False
Responses
HTTP 201 Created
The ID of the current cart. Use this ID for any cart API calls that
require the cart_id as a path parameter.
77ae13b3-c645-4bca-bb01-d8855ecd879a
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
{
"cart_id": "77ae13b3-c645-4bca-bb01-d8855ecd879a",
"links": [
{
"rel": "review",
"href": "/membership/4762338e-835f-48e4-b5bc-a928c6c76c5a"
}
]
}
Set members status in cart
Description
Sets status to active or inactive for one or more members.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
List of member guids with the new status
GUID of member to set status for.
88ae13b3-e645-abca-7b01-d8755ecd87ff
Set to true to mark the member as active. Set to false to set the member as inactive.
true
Responses
HTTP 200 OK
Set members rates in cart
Description
Choose the member rate members in the cart. (member rate clients only)
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
List of member guids with the new status
GUID of member
88ae13b3-e645-abca-7b01-d8755ecd87ff
Member Rate ID to set for member
MR1234
Responses
HTTP 200 OK
Apply discount groups
Description
Apply Discount Groups to the cart in order to reduce the price of the membership. The changes in price can be seen in the Get Review Information API call.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
List of discount group IDs to apply
["DG3982","DG221"]
Responses
HTTP 200 OK
Get membership agreements
Description
This call is used to retrieve all agreements associated with this membership.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aResponses
HTTP 200 OK
If set to type_name, then these agreements are set up to accept a typed name as the signature. If set to signature, then these agreements are set up to accept a signature image.
type_name
type_name, signature
The list of agreements
The agreement ID
W293
The agreement title
Make up policy
The actual text of the agreement. Note that this content might contain HTML because Daxko Operations uses a rich text editor to allow advanced formatting.
I agree that you will forfeit your lesson fee if I do not cancel within 2 hours of class start time.
Indicates whether the agreement has previously been accepted
true
{
"signature_type": "type_name",
"agreements": [
{
"agreement_id": "W293",
"title": "Make up policy",
"body": "I agree that you will forfeit your lesson fee if I do not cancel within 2 hours of class start time.",
"accepted": false
},
{
"agreement_id": "W297",
"title": "Consent for emergency medical treatment",
"body": "I grant authorization to a licensed physician to treat msyelf in case of a medical emergency.",
"accepted": true
}
]
}
Accept membership agreements
Description
This call is used to save and sign agreements associated with a membership. Either signee_name or signature_image_base64 is required.
Example body with signee_name:
{
"agreement_ids": ["W293"],
"signee_name": "John Doe"
}
Example body with signature_image_base64:
{
"agreement_ids": ["W293"],
"signature_image_base64": "iVBORw0KGgoAAAANSUhEUgAAAV8AAAA6..."
}
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
A list of agreement IDs.
["W3982","W221"]
The name of the signee.
John Doe
Base64 encoded PNG signature image. This should be a black and white image with the pen stroke being black like the one being generated by this signature pad plugin.
iVBORw0KGgoAAAANSUhEUgAAAV8AAAA6...
Responses
HTTP 200 OK
true
{
"success": true
}
Get review information
Description
This call is used to retrieve all of the information needed to review the cart before checkout.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aResponses
HTTP 200 OK
Fees that will be charged in the future on a recurring basis (see billing_cycle for frequency)
ID of the line item
1435
Short description of the fee
Membership Due
The line item type. A description of each type is detailed in the table below.
| type | description |
|---|---|
| join | Join Fee |
| membership | Membership Fee |
| recurring | Pro-rated one-time fee based on future recurring fee |
membership
join, membership, recurring
The line item price per unit
82.34
The line item quantity
1
Valie is true if this line item is able to be deleted.
true
A list of discounts applied to the line item.
The ID of discount.
23432
The name of discount.
Discount Name
The type of discount.
adjustment
The discount amount.
34.2
Can the discount be removed.
true
The tax information of the discount.
ID of tax line item
43321
Description of tax
Sales Tax
Tax amount
8.54
Rate of the tax
0.056
The taxes applied to this fee.
ID of tax line item
43321
Description of tax
Sales Tax
Tax amount
8.54
Rate of the tax
0.056
Fees that will be charged immediately at time of checkout (but might not be due immediately - see one_time_fees.due_today_amount)
The line item ID of the fee.
78e37dcd-9cf8-4fb8-903a-a5437f2c3d9e
The description of the fee.
Join Fee
The type of fee
join
The unit price of fee.
75
Quantity
1
Extended Price
2
Due today amount.
1
Whether the fee is removable.
true
The discounts applied to this fee.
The ID of discount.
23432
The name of discount.
Discount Name
The type of discount.
adjustment
The discount amount.
34.2
Can the discount be removed.
true
The tax information of the discount.
ID of tax line item
43321
Description of tax
Sales Tax
Tax amount
8.54
Rate of the tax
0.056
The taxes applied to this fee.
ID of tax line item
43321
Description of tax
Sales Tax
Tax amount
8.54
Rate of the tax
0.056
The cart version serves as a verification value that an order has been reviewed before being finalized. It will need to be passed into the membership checkout API call.
AAAAAAmnQ28=
Membership type that the member is signing up for / renewing
The ID of the membership type.
MT200
The name of membership type.
Family
Whether the membership type is auto renewable.
true
The term of membership.
The term description
Monthly
The ID of the term.
0
The number of months associated with the term
1
List of discount group ids that have been applied to this cart.
["DG3982","DG221"]
Member's home branch
Branch ID
B32
Name of branch
Daxkoville YMCA
Full address of branch
600 University Park Place, Birmingham, AL 35209
Branch phone number
(555) 555-5555
Billing cycle information
Name of the billing cycle
Monthly, Quarterly, Semi Annual, Annual
Number of months in the cycle
1, 3, 6, 12
List of available billing cycles
Name of the billing cycle
Monthly, Quarterly, Semi Annual, Annual
Number of months in the cycle
1, 3, 6, 12
Selected draft day (day of month)
28
List of available draft days
Day of month
28
Display friendly description for day of month
28th
Valie is true if the membership is set to auto renew.
true
Date when next recurring_fees will be converted to actual fees.
2021-04-01
When auto_renew is true, this property will not exist because there is no expiration date. When auto_renew is false, this will be when the membership will expire.
Value is true if this cart is in the mode of renewing a unit (vs. joining)
true
Members that are in the cart
Unique ID that only can only be used to modify or delete members in the cart. Once the checkout is complete or canceled, this ID no longer has any meaning.
66ae13b3-c645-4bca-bb01-d8845ecd879a
First name
Steven
Last name
Wills
Value is true if this is the primary member. There can only be 1 primary member.
true
Value is true if the member will be active in the membership once checkout is complete.
true
The age group that the member is assigned to based on age.
CDAG1111'
Youth
1
18
18 and under
any_child
Email address
st@daxko.com
Value is true if the active flag can be changed depending on membership type.
true
Value is true if this member is allowed to be removed from the cart.
true
Birth date
1992-04-27
(Member rate clients only) the chosen member rate for this member.
MR1234
My Member Rate
Program Memgbers
Membership start date
2023-07-18T00:00:00.0000000
Membership end date. NOTE: the value will be 9999-01-01T00:00:00.0000000 for inactive memberships that don't have an end date
2024-07-18T00:00:00.0000000
If the client has the Age Groups feature enabled in Daxko Operations for this membership type, then this gives information about these rules and whether they are satisfied.
Value is true if all of the rules are satisfied.
true
Age group rules
Maximum number of members allowed in this group
7
Minimum age range (inclusive) allowed in this group
1
Maximum age range (inclusive) allowed in this group
18
Display friendly description of the rules
Under 18
Value is true if all of the rules are satisfied for this group
true
Value is true if the maximum number of members has been reached for this group
true
Value is true if a payment method can be supplied. For example, if the membership is free after discounts have been
applied and all recurring fees will be free in the future, the value will be false.
true
Value is true if there are no errors and all age_group_rules are valid.
true
Any errors that must be resolved before checkout can complete
Error message
At least 1 member must be active
Steps that are part of the join/renew process.
These steps must be completed in order to check out. For example, if agreements is in the list, membership agreements must be accepted in order to check out.
One-time Link
Description
Generates a one-time link (valid for 10 minutes) that takes the user to a page in Daxko Operations Online to finish the member join/renew process. One the link has been used once, it is no longer valid.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
URI to redirect to after member join/renew process succeeds.
https://www.example.org/my_success_page
Step to show in the browser.
pay
Show or hide the Daxko Operations Online header. Defaults to show
show, hide
Responses
HTTP 200 OK
One-time URL to redirect user to in order to complete process in Daxko Operations Online
https://operations.daxko.com/online/9991/cart/redirector.mvc?code=_qNGKAKowkSmHDzCN6y8zT4bxCCD2LZgBN8m4ko_6E0&__header=show&__footer=hide&__nav=hide
{
"url": "https://operations.daxko.com/online/9991/cart/redirector.mvc?code=_qNGKAKowkSmHDzCN6y8zT4bxCCD2LZgBN8m4ko_6E0&__header=show&__footer=hide&__nav=hide"
}
Checkout
Description
This call completes the registration. Once the registration is submitted, it is processed synchronously (the unit/members are created immediately).
You can use the returned unit_id to call the get-unit-details endpoint API call.
Example request body:
{
"version": "AAAAAAmirMM=",
"customer": {
"name": "John Doe",
"email": "john.doe@example.org"
},
"payment_info": [
{
"payment_method_amount": 90,
"apply_system_credit_amount": 10,
"billing_method": {
"id": "PTLvg3hhYLPUqaBJcHIybjIokxLwR6RHG4zdhF6zZQdZM",
"save": true
},
"line_item_payments": [
{
"line_item_id": "4f04bd57-a51b-4d55-85ea-b6f4d7a64090",
"amount": 40,
"schedule_remaining": false
},
{
"line_item_id": "fe591b03-79a6-4d07-a0ac-64574a35896d",
"amount": 60,
"schedule_remaining": false
}
]
}
]
}
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
The get cart api call returns back this version value every time the call is made. The latest version must be included when performing the final checkout as a check to make sure that the most up to date has been reviewed.
AAAAAAmirMM=
Information about the customer that is checking out.
Name of customer that is performing purchase. This name will be returned in the receipt api call.
John Doe
Customer's email address that the receipt will be emailed to. If this is left blank, then an email will not be sent.
john.doe@example.org
Payment info for payment method. Only 1 payment method at a time is currently supported.
Amount that is being paid from the specified payment method (i.e., $100 is being paid by a VISA payment method)
90
If system credit is available on the account, this is the amount that is being paid from available system credit.
10
Information about billing method used to pay for this cart. Not required if payment is not being collected and the balance should go on the unit's account.
ID of billing method. Is either a Daxko Payment Token (prefixed with 'PT') or a stored billing method in Daxko Operations (prefixed with 'BM')
PTLvg3hhYLPUqaBJcHIybjIokxLwR6RHG4zdhF6zZQdZM
Should the information on the Daxko Payment Token be stored for future use as a stored billing method in Daxko Operations? (This property is ignored if using an id prefixed with BM since it is already stored in Daxko Operations).
false
true
This is a mapping of how much of the total payment amount (payment_method_amount + apply_system_credit_amount) is applied to each line item. The sum of all line_item_payments.amount must equal (payment_method_amount + apply_system_credit_amount). An entry is required for each line item even if applying $0.
The ID of the line item from the get cart api call.
4f04bd57-a51b-4d55-85ea-b6f4d7a64090
Amount of payment_method_amount + apply_system_credit_amount that should be applied to this line item. For example, if payment_method_amount is $90 and apply_system_credit_amount is $10 and this amount is $20, this means that $20 of the $100 will be applied to this line item.
40
This only applies if the full balance of this line item is not being immediately paid. If true, then a scheduled payment will be automatically created on the line item's due date for the remaining balance. If false, then the balance will remain on the account and must be handled manually within Daxko Operations.
true
true
Responses
HTTP 200 OK
Indicates if the operation succeeded. If it did not, then the errors collection will contain additional information.
true
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
review
The preconstructed URL to the related resource.
/membership/db2c4395-888c-42ce-9056-08e2f8a5f2d0
Unit ID of unit that was created/renewed
300181529
{
"success": true,
"links": [
{
"rel": "receipt",
"href": "/membership/417d82fc-c6ae-45fa-a285-c9314b0d3700/receipt"
},
{
"rel": "unit",
"href": "/units/300181529"
}
],
"unit_id": "300181529"
}
Get receipt
Description
This call is used to retrive receipt after a member join/renew has been completed.
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aResponses
HTTP 200 OK
Unit ID that was created (if joining) or the unit id that was renewed (if renewing).
300181529
Date/time the cart was checked out at (UTC)
2020-09-09
A list of payments that have been made against the cart
Display name of the payment payment_method
Bank Draft
Name on the payment method name_on_account
John Doe
Additional information about the payment method. For example, for EFT and credit card payments, will be a description with the last 4 digits of the account.
(ending in 1234)
Payment amount
55.45
Payments that have been scheduled for the future as a part of this cart. If no payments were scheduled, then this will be empty.
Line item id that this scheduled payment was created for. See line_items.
aaaaaaaa-2f3d-46b4-b524-c20ac6d06ef7
Date that this scheduled payment will be made on.
2017-10-12T00:00:00.0000000
Amount of scheduled payment
20.75
One time fees
The line item ID.
307b94ae-fb6f-4382-b623-9b772ae07c83
The line item type. A description of each type is detailed in the table below.
| type | description |
|---|---|
| join | Join Fee |
| membership | Membership Fee |
| recurring | Pro-rated one-time fee based on future recurring fee |
join, membership, recurring
The line item short description.
The line item price per unit.
The line item quantity.
The price for all quantities. Equal to quantity * unit_price.
The date when the min_payment_amount is due.
The amount that will be paid by the payment method.
The balance amount due after discounts, system_credit_amount, and payment_method_amount
A list of discounts applied to the line item.
Type of discount
Dollar amount of discount
Discount description
A list of tax info for this discount group if sales tax applies to this line item
tax amount
2.56
Description of tax
Sales Tax
tax rate
0.056
A list of tax info applied to the line item if sales tax applies to this line item
tax amount
2.56
Description of tax
Sales Tax
tax rate
0.056
Recurring fees
The line item ID.
307b94ae-fb6f-4382-b623-9b772ae07c83
The line item type. A description of each type is detailed in the table below.
| type | description |
|---|---|
| mebership_fee | Membership Fee |
membership_fee
The line item short description.
The line item price per unit.
The line item quantity.
The price for all quantities. Equal to quantity * unit_price.
The date when the min_payment_amount is due.
The amount that will be paid by the payment method.
The balance amount due after discounts, system_credit_amount, and payment_method_amount
A list of discounts applied to the line item.
Type of discount
Dollar amount of discount
Discount description
A list of tax info for this discount group if sales tax applies to this line item
tax amount
2.56
Description of tax
Sales Tax
tax rate
0.056
A list of tax info applied to the line item if sales tax applies to this line item
tax amount
2.56
Description of tax
Sales Tax
tax rate
0.056
Membership type info
Name of membership type
Family
Billing cycle information
Name of the billing cycle
Monthly, Quarterly, Semi Annual, Annual
Number of months in the cycle
1, 3, 6, 12
Date of the next draft of recurring fees
2020-01-28
Information about customer
Customer phone number
Daxko Operations unit ID
Name of person who performed purchased_by
Email provided at checkout
Daxko Operations unit name
Address
Information about vendor
Name of vendor
My Branch
Address
Tax ID of vendor
Vendor phone number
List membership join changes
Description
This endpoint returns a list of members who have joined or have been activated within the specified date range. Note that historical status changes of the member is not being considered here.
Query Parameters
The start date for the date range.
2020-02-15The end date for the date range.
2020-02-21Responses
HTTP 200 OK
The total number of members retrieved.
1
A list of members who have joined or rejoined.
The ID of the member.
90000059546-01
The name of the member.
Ben Adams
The timestamp (in UTC) when the membership was changed.
2020-08-26T15:51:08.4400000
The previous membership type of the member.
Family1
The current membership type of the member.
Family1
The previous status of the member.
Inactive
The current status of the member.
Active
The description of the membership change.
Membership Renewal
The type of membership change (i.e. Member Activated or Member Rejoined or Member Renewed).
Member Renewed
List membership cancel changes
Description
This endpoint returns a list of members who have canceled or have been deactivated within the specified date range. Note that historical status changes of the member is not being considered here.
Query Parameters
The start date for the date range.
2020-02-15The end date for the date range.
2020-02-21Responses
HTTP 200 OK
The total number of members retrieved.
1
A list of members who have canceled their memberships.
The ID of the member.
90000059546-01
The name of the member.
Ben Adams
The timestamp (in UTC) when the membership was changed.
2020-08-26T15:51:08.4400000
The previous membership type of the member.
Family1
The current membership type of the member.
Family1
The previous status of the member.
Active
The current status of the member.
Inactive
The description of the membership change.
Membership Terminated
The type of membership change (i.e. Member Deactivated).
Member Deactivated
List membership hold changes
Description
This endpoint returns a list of members who have been put on hold (and are active) within the specified date range. Note that historical status changes of the member is not being considered here.
Query Parameters
The start date for the date range.
2020-02-15The end date for the date range.
2020-02-21Responses
HTTP 200 OK
The total number of members retrieved.
1
A list of members who have been put on hold.
The ID of the member.
90000059546-01
The name of the member.
Ben Adams
The timestamp (in UTC) when the membership was changed.
2020-08-26T15:51:08.4400000
The previous membership type of the member.
Family1
The current membership type of the member.
Family1
The reason for the membership change (e.g. Travel, Military, etc.).
Military
The description of the membership change.
Membership held with dues from 8/26/2020 to 8/27/2020
The type of membership change (e.g., Member Activated or Member Rejoined or Member Renewed).
Membership Hold
List membership add-on changes
Description
This endpoint returns a list of membership add-ons that have been applied or removed, per member.
Query Parameters
The start date for the date range.
2020-02-15The end date for the date range.
2020-02-21Responses
HTTP 200 OK
The total number of records retrieved.
1
A list of members who have an add-on change.
The ID of the Unit.
90000059546
The ID of the member.
90000059546-01
The name of the member.
Ben Adams
The membership type ID of the member.
MT165
The membership type of the member.
Family
The ID of the add-on applied or removed.
34
The name of the add-on applied or removed.
Facility Access - Unit
The ID of the branch for the applied or removed add-on.
B27
The name of the branch for the applied or removed add-on.
Downtown Branch
The type of add-on applied or removed.
Membership
How the applied or removed add-on is charged.
By unit
The timestamp (in UTC) when the add-on was applied or removed.
2020-08-26T15:51:08.4400000
The type of change that was made, whether the add-on was applied or removed.
Add-on Applied
Get Add-Ons
Description
Gets Unit and Member Level Add-Ons information needed to build a custom Add-On experience
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aResponses
HTTP 200 OK
Selected Membership Type Name
Family (Monthly)
Selected Membership Type's Billing Cycle Interval
Monthly
Total due per Billing Cycle
100.00
Total due at checkout
50.00
Branch ID of the selected membership type
27
Whether the selected membership type allows recurring donations during the cart process
true
Recurring donation amount selected during the join process
10.00
The Donation information setup by the client for recurring donations during Member Join for this Membership Type
"donation": {
"product_bundle_id": "a5e52378-8727-4500-9c40-69c1e1b3a9c9",
"campaign_id": 4891,
"campaign_description": "Recurring Donation for Member Join Campaign",
"donation_message": "An opportunity to give to your local establishment on a recurrent basis.",
"suggested_amounts": [
500.0000,
250.0000,
100.0000,
50.0000,
25.0000
],
"min_amount": 10.00,
"gl_id": 1234,
"is_recurring": true
}
Selected Campaign ID for the in cart donation
The Campaign description
A message to display for the potential donor
Pre-set suggested amounts to donate
The minimum allowed donation amount
The General Ledger for the campaign
Whether this will be created as a recurring donation
An array of selected recurring fees based on the built Membership
"recurring_fees": [
{
"fee_name": "Membership Due",
"amount": 100.00
},
{
"fee_name": "Facility Access (Member)",
"amount": 50.00
},
...
]
The name of the selected recurring fee
The amount charged for the recurring fee per billing cycle
An array of members in the Member Join cart
"members": [
{
"member_guid": "02c6c5be-48e3-464c-b7dd-a7e16a82ed50",
"member_name": John Doe
},
{
"member_guid": "2b9aee54-57a1-4b77-bc79-62a58f9f320a",
"member_name": Jane Doe
},
...
]
The unique identifier of the member used to assign "By Member" add-ons to the member
The name of the member
An array of "By Member" and "By Unit" add-ons available to assign to the Unit or Members in the cart
"addons": [
{
"fee_id": 79620,
"branch_id": 476,
"addon_name": "Facility Access (Member)",
"amount": 15.0000,
"is_added": false,
"number_added": 0,
"addon_charge_type": "By member",
"description": "Facility Access to the selected branch for a single member.",
"member_guids": []
},
{
"fee_id": 79617,
"branch_id": 27,
"addon_name": "Facility Access (Unit)",
"amount": 75.0000,
"is_added": false,
"number_added": 0,
"addon_charge_type": "By unit",
"description": "Facility Access to the selected branch for the entire unit.",
"member_guids": []
},
{
"fee_id": 79615,
"branch_id": 41,
"addon_name": "Towel Service",
"amount": 5.0000,
"is_added": false,
"number_added": 0,
"addon_charge_type": "By member",
"description": "Get a nice, fresh towel",
"member_guids": []
},
...
]
The ID used to add this add-on to the Member Join cart
The linked branch for this add-on
The name of the add-on
The amount charged for this add-on per billing cycle
Whether this add-on is already added to the current cart
The number of times this add-on has been added to the current cart
The type of add-on
By unit, By member
The description of the add-on
For "By Member" add-ons, the members that have been assigned this add-on
Save Add-Ons
Description
Save Unit and/or Member Level Add-Ons to the current cart
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
List of add-ons adding to the current cart
The ID used to add this add-on to the Member Join cart
6542
The unique identifier of the member used to assign "By Member" add-ons to the member
2b9aee54-57a1-4b77-bc79-62a58f9f320a
Responses
HTTP 200 OK
true
HTTP 400 BadRequest
false
List of errors
The error message from the failed attempt
Remove Add-Ons
Description
Remove Unit and/or Member Level Add-Ons from the current cart
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
The ID used to add this add-on to the Member Join cart
6542
The unique identifier of the member used to assign "By Member" add-ons to the member
2b9aee54-57a1-4b77-bc79-62a58f9f320a
Responses
HTTP 200 OK
true
HTTP 500 BadRequest
false
List of errors
The error message from the failed attempt
Add a recurring donation
Description
Add a recurring donation to the current cart
Path Parameters
The ID of the cart.
77ae13b3-c645-4bca-bb01-d8855ecd879aRequest Body
The recurring donation amount assigned to the member join cart
10.00
Responses
HTTP 200 OK
true
Partners
The Partners API allows retrieval of partner resources and authentication.
List partners
Description
Retrieves all partners.
Header Parameters
The API Key that allows access to internal endpoints. Find the API key for your environment here.
Responses
HTTP 200 OK
A list of partners
The username the partner uses to authenticate.
A list of clients IDs that the user has been granted access. If is_trusted is true, then client_ids will be ommitted.
The API gateway ID that corresponds to this partner.
Indicates whether the partner has been granted access to all clients. If client_ids are specified, then is_trusted will be false.
A list of APIs that the partner has been granted access.
The number of partners returned in the response.
{
"total": 2,
"users": [
{
"username": "internal_api_user",
"gateway_id": "bb4a074753b749319088c860dd3729de",
"is_trusted": true,
"apis": [
"ops_api_v2",
"ops_api_v2_auth"
]
},
{
"username": "partner_api_user",
"client_ids": [
1000,
2000,
3000
],
"gateway_id": "751f4240b72a4959a6a1ce5e246830af",
"is_trusted": false,
"apis": [
"ops_api_v2",
"ops_api_v2_auth"
]
}
]
}
Create a partner
Description
Creates a partner
Header Parameters
The API Key that allows access to internal endpoints. Find the API key for your environment here.
Request Body
The username the partner will use to authenticate
The password the partner will use to authenticate
The client_ids that the partner has access to. Either client_ids or is_trusted parameter must be defined.
Indicates whether this partner has access to all clients. Either is_trusted or client_ids parameter must be defined.
The list of APIs the partner has access to.
Responses
HTTP 201 Created
The username of the partner
The IDs of the clients that the partner has access to. If is_trusted is true, then client_ids will be ommitted.
The API Gateway ID corresponding to this partner.
Indicates whether this partner has access to all clients.
The list of APIs the partner has access to.
The new refresh_token to be used to generate access_tokens.
{
"username": "internal_api_user",
"gateway_id": "bb4a074753b749319088c860dd3729de",
"client_ids": [
9999,
9998
],
"is_trusted": false,
"apis": [
"ops_api_v2",
"ops_api_v2_auth"
],
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJpbnRlcm5hbF9hcGlfdXNlciIsImlzcyI6ImludGVybmFsX2FwaV91c2VyLWF1dGgifQ.KuQQ6pu0slD0Rfhqy5Qz3emTMdSKIoBtPyLPss4nx2Y"
}
Get partner details
Description
Get partner details
Header Parameters
The API Key that allows access to internal endpoints. Find the API key for your environment here.
Path Parameters
Username of partner to retrieve
Responses
HTTP 200 OK
The username of the partner
The IDs of the clients that the partner has access to. If is_trusted is true, then client_ids will be ommitted.
The API Gateway ID corresponding to this partner.
Indicates whether this partner has access to all clients.
The list of APIs the partner has access to.
{
"username": "internal_api_user",
"gateway_id": "bb4a074753b749319088c860dd3729de",
"client_ids": [
9999,
9998
],
"is_trusted": false,
"apis": [
"ops_api_v2",
"ops_api_v2_auth"
]
}
Update a partner
Description
Updates a partner details.
Header Parameters
The API Key that allows access to internal endpoints. Find the API key for your environment here.
Path Parameters
Username of partner to update
Request Body
The updated username the partner will use to authenticate
The updated password the partner will use to authenticate
The updated IDs of clients that the partner has access to. Either client_ids or is_trusted parameter must be defined.
Indicates whether this partner has access to all clients. Either is_trusted or client_ids parameter must be defined.
The list of APIs the partner has access to.
Responses
HTTP 200 OK
The username of the partner
The IDs of clients that the partner has access to. If is_trusted is true, then client_ids will be ommitted.
The API Gateway ID corresponding to this partner.
Indicates whether this partner has access to all clients.
The list of APIs the partner has access to.
The new refresh_token to be used to generate access_tokens.
{
"username": "internal_api_user",
"gateway_id": "bb4a074753b749319088c860dd3729de",
"is_trusted": "false,",
"client_ids": [
9999,
9998
],
"apis": [
"ops_api_v2"
],
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJpbnRlcm5hbF9hcGlfdXNlciIsImlzcyI6ImludGVybmFsX2FwaV91c2VyLWF1dGgifQ.KuQQ6pu0slD0Rfhqy5Qz3emTMdSKIoBtPyLPss4nx2Y"
}
Delete a partner
Description
Deletes a partner and any access they have to API resources.
Header Parameters
The API Key that allows access to internal endpoints. Find the API key for your environment here.
Path Parameters
The username of the partner to delete
Responses
HTTP 204 No Content
Create partner access token
Description
This is an OAuth 2.0 authorization endpoint for retrieving partner tokens. It returns a JSON web token (JWT) to use for access to API resources. This token provides scoped access to data specified with the scope parameter. See the Authorization tutorial for more information.
Request Body
The OAuth 2.0 grant type supported by this endpoint.
client_credentials
The partner username provided by Daxko
The partner password provided by Daxko
A space-delimited list of scope:value pairs. Sets the scopes which the token will be restricted.
Format is <scope_name>:<scope_value> [<scope_name>:<scope_value>]
Valid scopes are
| Scope | Description | Value Type |
|---|---|---|
client | The token will be restricted to this client | integer |
tokenize | The cart_id of the registration | UUID |
client:9999 tokenize:9e606048-9e89-40bb-9ed1-3bda8f65d1fc
Responses
HTTP 200 OK
The issued access token. When the grant type is client_credentials, the access_token should always be secured on your server and not be sent to a web browser or mobile device.
The type of token issued.
bearer
The lifetime in seconds of the access token.
3600
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJhcGlfdXNlci0wMDAwIiwic3ViIjoiYXBpX3VzZXIiLCJpYXQiOjE0ODcxODYzMDksImV4cCI6MTQ4NzI3MjcwOSwiY2xpZW50X2lkIjowLCJhcGkiOiJvcHNfYXBpX3YyIn0.rvi7z3UcXWiKhesr8Qbx_vwi_pEFudHn7d3fbeCQZ1o",
"token_type": "bearer",
"expires_in": 86400
}
HTTP 400 Bad Request
The type of the error occured.
invalid_request, invalid_client, invalid_grant, unauthorized_client, unsupported_grant_type, invalid_scope
The description about the error occured.
Create member access token
Description
This is an OAuth 2.0 authorization endpoint for retrieving member scoped access tokens. See Member Authentication Tutorial
Request Body
The OAuth 2.0 grant type supported by this endpoint.
authorization_code, refresh_token
The partner username provided by Daxko
The partner password provided by Daxko
The authorization code that Daxko redirects to your site with via the code URL parameter. Required when grant_type is authorization_code.
haOFJDr87EaP0d0tllfL0MHsVfIvJTHaOPPaTbixRXw
The exact redirect URL that you used when you built the URL to the Daxko Operations Auth Form. Required when grant_type is authorization_code.
https://www.mysite.com/login_success
The refresh_token to exchange for an access_token. Required when grant_type is refresh_token.
kaQFJDr8mEaPas34f0tllfL0MvbhsVfIffJHaOPPaTbij
Responses
HTTP 200 OK
The issued access token scoped to a single member
The issued refresh token scoped to a single member. This will expire in 90 days from being issued or when the member changes their password.
The type of token issued.
bearer
The lifetime in seconds of the access token.
600
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJhcGlfdXNlci0wMDAwIiwic3ViIjoiYXBpX3VzZXIiLCJpYXQiOjE0ODcxODYzMDksImV4cCI6MTQ4NzI3MjcwOSwiY2xpZW50X2lkIjowLCJhcGkiOiJvcHNfYXBpX3YyIn0.rvi7z3UcXWiKhesr8Qbx_vwi_pEFudHn7d3fbeCQZ1o",
"token_type": "bearer",
"expires_in": 600
}
HTTP 400 Bad Request
The type of the error occured.
invalid_request, invalid_client, invalid_grant, unauthorized_client, unsupported_grant_type
The description about the error occured.
Get member OAuth2 settings
Description
Get member-authentication OAuth2 form Settings. See Member Authentication Tutorial for more details.
Responses
HTTP 200 OK
The OAuth2 settings associated with the principal.
List of redirect URLs on your site that are valid for Daxko Operations to redirect to after the member is authenticated.
A list of links for authentication-management purposes.
URL on your site that handles the sign-up process. The property name must exist in the request, but you can leave it as empty string for no link to be displayed on Daxko's form.
https://www.example.com/my_sign_up_process
The URL for the sign-up process.
URL on your site that handles the forgot-password process. The property name must exist in the request, but you can leave it as empty string for no link to be displayed on Daxko's form.
https://www.example.com/my_forgot_password_process
{
"settings": {
"valid_redirect_uris": [
"https://www.mysite.org/successful_login"
],
"links": {
"sign_up": {
"url": "https://www.mysite.org/my_sign_up_process"
},
"forgot_password": {
"url": "https://www.mysite.org/my_forgot_password_process"
}
}
}
}
Save member OAuth2 settings
Description
Configure member authentication OAuth form. See Member Authentication Tutorial for more details.
NOTE: the Authorization header should use the main access token used for other api calls.
Example Headers:
"Authorization": "Bearer <your_access_token>"
"Content-Type": "application/json"
"Accept": "application/json"
Request Body
The OAuth2 settings associated with the principal.
List of redirect URLs on your site that are valid for Daxko Operations to redirect to after the member is authenticated.
A list of links for authentication-management purposes.
URL on your site that handles the sign-up process. The property name must exist in the request, but you can leave it as empty string for no link to be displayed on Daxko's form.
https://www.example.com/my_sign_up_process
The URL for the sign-up process.
URL on your site that handles the forgot-password process. The property name must exist in the request, but you can leave it as empty string for no link to be displayed on Daxko's form.
https://www.example.com/my_forgot_password_process
Responses
HTTP 200 OK
Whether the operation was completed successfully.
{
"success": true
}
Password Recovery
The Password Recovery API allows a member to reset their password if forgotten.
Send password recovery email
Description
The email will be set with from address sent to client email address. The URL in the email will follow the format
<reset-url>?<token_parameter_name>=<generated-token>.
For example, the request
POST /password_recovery
{
"username": "johndoe@daxko.com",
"reset_url": "https://www.sample.com",
"token_parameter": "token-parameter"
}
would generate an email with HTML
<html>
<div style=""display: none;""> </div>
<body>
<div>
You recently requested to reset your password for your account.
Click the link below to reset it.
</div>
<div> </div>
<div><strong>This password reset is only valid for 24 hours.</strong></div>
<div> </div>
<div><a href="https://www.sample.com:443/website?token-parameter=b4277211-c138-47b3-abfc-a050f6f01517">Reset Password</a></div>
<div> </div>
<div>If you did not request a password reset, please ignore this email or <a href="mailto:support@sample.com">contact support</a> if you have questions.</div>
<div> </div>
<div>If you're having trouble with the link above, copy and paste the URL below into your browser.</div>
<div> </div>
<div>
<a href="https://www.sample.com:443/website?token-parameter=b4277211-c138-47b3-abfc-a050f6f01517">
https://www.sample.com:443/website?token-parameter=b4277211-c138-47b3-abfc-a050f6f01517
</a>
</div>
</body>
<footer><strong>Daxko Gym</strong></footer>
</html>
Request Body
Username of member requesting password recovery
The base URL of where the token
The query parameter name that will contain the token value.
tokenResponses
HTTP 200 OK
Create password recovery token
Description
This token can be used to reset a member's password. This is useful for custom reset password mechanism and if you prefer to send your own custom reset password template emails. The token returned by this endpoint can be used in the POST /password_recovery/token/{id} endpoint.
Request Body
Username of member requesting password recovery
Responses
HTTP 201 Created
The password recovery token to be used when calling the POST /password_recovery/token/{id} endpoint.
b4277211-c138-47b3-abfc-a050f6f01517
{
"token": "b4277211-c138-47b3-abfc-a050f6f01517"
}
Verify password recovery token
Description
This endpoint is useful for validating a token before making a call to the POST /password_recovery/token/{id} endpoint.
Path Parameters
Password reset token generated by API
b4277211-c138-47b3-abfc-a050f6f01517Responses
HTTP 204 No Content
Change member password
Description
This endpoint will change a member's password and send an email notifying the member of the password change with the following content:
<html>
<div style=""display: none;""> </div>
<head>
<title></title>
</head>
<body>
<div>The password for your account was recently changed.</div>
<div> </div>
<div>If you made this change, you don't need to do anything more.</div>
<div> </div>
<div>If you didn't make this change, please <a href=""mailto:{Client Email Address}"">contact support</a> to let us know.</div>
</body>
<footer><strong>{Client Name}</strong></footer>
</html>
Path Parameters
Password reset token generated by API
b4277211-c138-47b3-abfc-a050f6f01517Request Body
New password for member
Responses
HTTP 204 No Content
Programs
The Programs API retrieves program data.
Search program offerings
Description
This call returns offerings for the different Daxko Operations program types as a common format and accepts a number of search parameters.
Query Parameters
Restricts results to match at least 1 of the specified start
time ranges. NOTE: If the source offering in Daxko Operations does not
have a time defined, then those results will always be returned but the
score will be lower.
[object Object],[object Object]Restricts results to have the specified start and end datetime
in at least one of the registration datetime ranges.
See As of date tutorial.
{ start:<datetime of request>, end:<datetime of request>, mode:registration_occurs_between, }{ start:2017-04-19T09:58:32, end:2017-04-23T09:58:32, mode:registration_occurs_between, }Restricts the results to comma delimited list of locations. If omitted, no location-based restrictions will be applied.
B27,S34Restricts the results to comma delimited list of categories. If omitted, no category based restrictions will be applied.
CAT1234,TAG3455Restricts the results to only be associated with certain types of program offerings. If omitted, returns offerings associated with all types of program offerings.
| Program Offering Type | Filter Value |
|---|---|
| Standard | session |
| Package | package |
| Childcare | rate_plan |
| Camp | camp_instance |
session, package, rate_plan, camp_instance
Restricts the list of offerings to only in-house or online program offerings. Default behavior is to return both in-house and online program offerings.
onlinein_house, online
Indicates whether to show inactive categories. Default behavior will omit inactive categories.
falseIndicates whether to show categories associated with inactive locations. Default behavior will omit categories associated with inactive locations.
falseRestricts results to be match at least 1 of the days as the
query parameter. The score on each individual result will be higher
if more days match. NOTE: If the source offering in Daxko Operations
does not have days offered defined, then those results will always be
returned, but the score will be lower.
1,3,5Keywords for performing full text search. The following fields are searched: offering name, offering description, program name, program description, category name, instructor name, contact name.
swim lessonsRestricts results that occur within at least one of the date ranges.
[object Object],[object Object]Restricts results based on comma-delimited list of birth dates. At least one of the birth dates in the collection must be eligible for the offering based on the offering set up in Daxko Operations.
1982-05-21,1981-06-28Controls whether facets (statistics) of the current search are
returned. This controls whether the facets property is returned.
falseIf include_facets query parameter is true, this allows customization of what
ranges are returned in facets.time_ranges.
[object Object],[object Object]Number of offering results to return (max of 100). If you set to 0 and set include_facets to true, you can still get the facet results without the individual offering results.
100100Determines how the offering results will be sorted. By default, the sorting will be by score (descending order). For more information on sorting options, see the Sorting section of the Getting Started Tutorial for more information. All fields correspond to the fields described in the response body.
The supported fields and their default sort orders for this API call are
| Field | Default sort order |
|---|---|
| score | descending |
| name | ascending |
| start_date | ascending |
-score+name,-scorename, score, start_date
Restricts the results to comma-delimited list of program ids. If omitted, no category-based restrictions will be applied.
TMP1234567,TMP8675309This parameter is used as a cursor to fetch the next page of results. Use
the after value from a previously returned response body, or,
use the URL link returned in the links response value to avoid having
to construct your own URL.
View the Paging section of the Getting Started Tutorial for more information.
c2FtcGxlIG5hbWUsb2ZmZXJpbmcjOTk5OS1DQzEyMzQtUlA1Njc4Responses
HTTP 200 OK
A pagination cursor to use when fetching the next page of results. This value will be omitted if the response contains the last page of results. View the Paging section of the Getting Started Tutorial for more information.
c2FtcGxlIG5hbWUsb2ZmZXJpbmcjOTk5OS1DQzEyMzQtUlA1Njc4
The maximum number of items requested. This value is the same value as the limit query parameter on the request.
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response. For example, the next relation indicates that the href property refers to the next page of results.
next
The preconstructed URL to the related resource. Use this to avoid constructing your own URLs and to embedded in href HTML attributes.
The total number of documents found that match the query criteria. This number can be greater than the number of results returned and is independent of the limit request query parameter value.
Search results. This property will only have results if the limit property is greater than 0 and there are matching results based on the input query parameters.
Offering id
Offering type
rate_plan, camp_instance, session, package
Offering name
Offering description
Offering start date
Offering end date
Program Information
Program ID
Program type
Program Name
Program description. NOTE: programs of type session and package will not have a description.
Locations of the offering
The ID of the location.
The name of the location.
The type of location, 'branch' or 'site'.
Categories that offering is a part of
The ID of the category.
The name of the category.
ID of the fee group
FG1234
Name of the fee group. This name is customizable by the client, so the values used in the examples will not always be used."
Members
Rate information
Minimum fee amount
Maximum fee amount
Frequency of rate
flat, weekly, bi_weekly, semi_monthly, daily, monthly
Unit that the amount is in.
week, every other week, semi-monthly, month, day
Display friendly description of rate
$100.00/week
Times that the offering occurs on. Offering types
of camp_instance and rate_plan will always return an
empty array. For offering type of session, times are
optional based on the set-up in Daxko Operations.
Start time in format of hh:mm.
End time in format of hh:mm.
Restriction Information
Genders that registration is restricted to
Single character id of gender
'M' or 'F'
Display friendly gender
'Male' or 'Female'
Date of birth restriction. This property will not exist if there is no dob restriction.
Start date of birth
End date of birth
Age restriction. This property will not exist if there is no age restriction.
Start age range
End age range
Days offered. This is an optional setting for all offering types, so the array might be empty.
ISO 8601 day of week identifier. 1 = Monday, 7 = Sunday.
1
Name of day of week
Monday
Relative score of offering based on search parameters. Results with higher relevance will have a higher number.
5.43232
If keywords is specified as a query parameter,
then this return snippets of matched text surrounded by
<mark> tags. Otherwise, this property will be an empty
array.
Key of matched property.
offering_name
Text snippets that match full text keywords
search. The matched text will be surrounded by <mark>
tags
Our <mark>swim</mark> classes are available during...
Summary of registration information
Minimum registration date/time (for any fee group)
Maximum registration date/time (for any fee group)
Whether registration is open or closed based on the as_of.start query parameter
open, closed
Statistical information based on the current query.
This property will only exist if include_facets query parameter
is true.
Location stats
Location ID
Location Name
Count of offerings that match this location
Count of programs that match this location
Indicates if the location is active.
Indicates if the location is set to be visible online
Category stats
Category ID
Category Name
Count of offerings that match this category
Count of programs that match this category
Indicates if the category is active.
Indicates if the category is set to be visible online
Day of week stats
ISO 8601 id for day of week. 1=Monday, 7=Sunday
Day of week name
Count of offerings that match this day of week
Count of programs that match this day of week
Program stats
Program ID
Program Name
Count of offerings that match this program
Time range stats. This property will only exist if the time_range_facets query parameter is supplied.
Start time in hh:mm format
End time in hh:mm format
Count of programs that match this time range
Count of offerings that match this time range
{
"total": 344,
"limit": 100,
"offerings": [
{
"id": "SES1811026",
"type": "session",
"name": "VE - 2015 Master's Swim ",
"description": "This is the offering description",
"start_date": "2015-01-01T00:00:00.0000000",
"end_date": "2015-12-31T00:00:00.0000000",
"program": {
"id": "TMP39688",
"type": "traditional",
"name": "Aquatics - Other",
"description": "This is the program description"
},
"locations": [
{
"id": "B447",
"name": "Branch #1",
"type": "branch"
}
],
"categories": [
{
"id": "TAG114",
"name": "Dance - Adult"
}
],
"groups": [
{
"id": "FG79",
"name": "Non-Members",
"rate": {
"min_amount": 10,
"max_amount": 10,
"frequency": "flat",
"unit": "",
"description": "$10.00"
}
},
{
"id": "FG78",
"name": "Program Member",
"rate": {
"min_amount": 10,
"max_amount": 10,
"frequency": "flat",
"unit": "",
"description": "$10.00"
}
}
],
"restrictions": {
"genders": [
{
"id": "M",
"name": "Male"
},
{
"id": "F",
"name": "Female"
}
],
"dob": {
"start": "1915-01-02T00:00:00.0000000",
"end": "1996-01-01T00:00:00.0000000"
},
"age": {
"start": 5,
"end": 8
}
},
"times": [
{
"start": "05:30",
"end": "06:30"
}
],
"days_offered": [
{
"id": "1",
"name": "Monday"
},
{
"id": "3",
"name": "Wednesday"
},
{
"id": "5",
"name": "Friday"
}
],
"highlights": [
{
"key": "offering_name",
"text": "VE - 2015 Master's <mark>Swim</mark> "
},
{
"key": "category_name",
"text": "Master's <mark>Swim</mark>"
}
],
"registration": {
"start": "2015-04-14T00:00:00.0000000",
"end": "2015-07-01T23:59:00.0000000",
"state": "closed"
},
"score": 4.334
},
"..."
],
"facets": {
"locations": [
{
"name": "Branch #1",
"id": "B221",
"program_count": 49,
"offering_count": 107
},
{
"name": "Branch #2",
"id": "B210",
"program_count": 2,
"offering_count": 5
},
{
"name": "Site #1",
"id": "S1234",
"program_count": 16,
"offering_count": 24
}
],
"categories": [
{
"name": "$50 Program Credit",
"id": "TAG43294",
"program_count": 1,
"offering_count": 11
},
{
"name": "AWAY Guest",
"id": "TAG6161",
"program_count": 1,
"offering_count": 11
},
{
"name": "Adult Sports",
"id": "TAG8557",
"program_count": 2,
"offering_count": 2
},
{
"name": "After School",
"id": "TAG4751",
"program_count": 1,
"offering_count": 3
}
],
"days_of_week": [
{
"name": "Monday",
"id": 1,
"program_count": 145,
"offering_count": 302
},
{
"name": "Tuesday",
"id": 2,
"program_count": 149,
"offering_count": 354
},
{
"name": "Wednesday",
"id": 3,
"program_count": 141,
"offering_count": 289
},
{
"name": "Thursday",
"id": 4,
"program_count": 144,
"offering_count": 373
},
{
"name": "Friday",
"id": 5,
"program_count": 132,
"offering_count": 240
},
{
"name": "Saturday",
"id": 6,
"program_count": 43,
"offering_count": 145
},
{
"name": "Sunday",
"id": 7,
"program_count": 27,
"offering_count": 45
}
],
"time_ranges": [
{
"start": "05:00",
"end": "10:59",
"program_count": 13,
"offering_count": 79
},
{
"start": "11:00",
"end": "16:59",
"program_count": 21,
"offering_count": 66
},
{
"start": "17:00",
"end": "22:00",
"program_count": 29,
"offering_count": 338
}
],
"programs": [
{
"id": "TMP1514722",
"name": "Swim Lessons - Pre-School - 1 Pike I - Level 1",
"offering_count": 49
},
{
"id": "TMP3668711",
"name": "Youth Sports - Flag Football ",
"offering_count": 43
},
{
"id": "TMP1515533",
"name": "Aquatics - Swim Lessons - Private Lessons",
"offering_count": 35
},
{
"id": "TMP1514933",
"name": "Swim Lessons - Youth - 1 Polliwog I",
"offering_count": 34
}
]
},
"after": "U2FtcGxlIE9mZmVyaW5nIE5hbWUsb2ZmZXJpbmcjOTk5OS1DQzEyMzQtUlA1Njc4",
"links": [
{
"rel": "next",
"href": "/programs/offerings/search?keywords=swim&limit=5&sort=name&after=U2FtcGxlIE9mZmVyaW5nIE5hbWUsb2ZmZXJpbmcjOTk5OS1DQzEyMzQtUlA1Njc4"
}
]
}
Get list of offerings for particular program
Description
This call returns offerings that are available for registration for the different Daxko Operations program types as a common format.
For traditional programs and program packages:
- The list of offerings is the list of sessions on this program combined with the location (there is only one possible location for a session or package)
- {program_id} refers to a program or package in Daxko Operations (go to Programs : Browse Programs : Select a tag) and then click then edit pencil next to the top level item in the tree. This will take you to ProgramTemplate.aspx?tid={program_id}.
- The prefix for a traditional program type is 'TMP'. Example: if you see ProgramTemplate.aspx?tid=1234, then the {program_id} to pass to this API call would be 'TMP1234'.
- The prefix for a program package type is 'PP'. Example: if you see ProgramTemplate.aspx?tid=1234, the the {program_id} to pass to this API call would be 'PP1234'.
For child care programs:
- The list of offerings is rate plans on this program combined with all of the possible locations on this program.
- {program_id} refers to a child care program in Daxko Operations (go to Child Care : Browse Programs : Filter by Child Care programs and click the edit pencil). This will take you to ProgramsWizard.mvc?program_id={program_id}.
- The prefix of the program type is 'CC'. Example: if you see ProgramsWizard.mvc?program_id=1234, then the {program_id} to pass to this API call would be 'CC1234'.
For camp programs:
- The list of offerings is camp instances on this program combined with all of the possible locations on this program.
- {program_id} refers to a child care program in Daxko Operations (go to Child Care : Browse Programs : Filter by Camp programs and click the edit pencil). This will take you to ProgramsWizard.mvc?program_id={program_id}.
- The prefix of the program type is 'CMP'. Example: if you see ProgramsWizard.mvc?program_id=1234, then the {program_id} to pass to this API call would be 'CMP1234'.
Path Parameters
See description above for examples of program ids.
Query Parameters
Restricts results to have the specified start and end datetime
in at least one of the registration datetime ranges. See As of date tutorial.
{start:<datetime of request>,end:<datetime of request>,mode:registration_occurs_between}{start:2017-04-19T09:58:32,end:2017-04-23T09:58:32,mode:registration_occurs_between}Comma-delimited list of category ids to filter by. Example: 'TAG1234' is programs tag with id 1234, 'CAT5678' is a child care/camp category with id 5678
Comma delimited list of location ids to filter by. Example: 'B1234' is branch with id 1234. 'S5678' is site with id 5678.
Filters results that are currently open for registration.
onlineonline, in_house
Comma delimited list of offering ids to filter by.
SES12345,SES67890Responses
HTTP 200 OK
Program information
Program name
Program description
If this is a traditional program, this is a list of sessions. If this is a Child Care program, this is a list of rate plans. If this is a Camp program, this is a list of camp instances.
Offering ID
Offering name
Offering description
Offering start date
Offering end date
Offering locations
Location ID
Location name
Availability information
true if the offering has a limited number of seats, false if offering has an unlimited number of seats
true if the offering has reached maximum number of seats. NOTE: for Child Care programs, this field is deprecated and the value will always be false for maintain backwards compatibility. Use the status for Child Care programs.
true if the offering has the waiting list option enabled
Status of availability. unknown will always be the value for child care programs (in order to determine availability of a child care program, you must use the Get program offering details API call.
unknown, full, availabile, full_with_waiting_list
Program fee groups
Fee group id
Fee group name
Rate information
Minimum fee amount
Maximum fee amount
Frequency of rate
flat, weekly, bi_weekly, semi_monthly, daily, monthly
Unit that the amount is in.
week, every other week, semi-monthly, month, day
Display friendly description of rate
$100.00/week
Genders that are allowed to register for program
M or F
M, F
Male or Female
Age range that is allowed to register for program. If this property does not exist, then there is not an age range restriction. This value is evaluated based on the offering start date.
Start age
End age
Date of birth range that is allowed to register for program. If this property does not exist, then there is not a date of birth restriction.
Start birth date
End birth date
For program packages only. The number of months after purchase when a package expires.
Days that the offering is available on. If the array is empty, this does not necessarily mean that the offering is not available on this day, it means that when the program was set up, this option was not set.
ISO8601 integer for day of week. 1 is Monday, 7 is Sunday, etc.
Full name of day of week
Monday
Times that the offering is available. The date portion is always returned as 1900-01-01. For example, 1900-01-01T08:00:00.0000000 means that the offering starts at 8:00 AM local time.
Start time
End time
Summary of registration information
Minimum registration date/time (for any fee group)
Maximum registration date/time (for any fee group)
Whether registration is open or closed based on the as_of.start query parameter
open, closed
{
"program": {
"name": "My program name",
"description": ""
},
"offerings": [
{
"id": "SES902199",
"name": "My session name",
"description": "My session description",
"start": "2020-01-01T00:00:00.0000000",
"end": "2020-01-02T00:00:00.0000000",
"locations": [
{
"id": "B12345",
"name": "My location name",
"availability": {
"limited": true,
"full": false,
"has_waiting_list": false,
"status": "available"
}
}
],
"groups": [
{
"id": "FG434",
"name": "Facility Member",
"rate": {
"min_amount": 10,
"max_amount": 10,
"frequency": "flat",
"unit": "",
"description": "$10.00"
}
},
{
"id": "FG79",
"name": "Non-Members",
"rate": {
"min_amount": 10,
"max_amount": 10,
"frequency": "flat",
"unit": "",
"description": "$10.00"
}
},
{
"id": "FG78",
"name": "Program Member",
"rate": {
"min_amount": 10,
"max_amount": 10,
"frequency": "flat",
"unit": "",
"description": "$10.00"
}
}
],
"restrictions": {
"genders": [
{
"id": "M",
"name": "Male"
},
{
"id": "F",
"name": "Female"
}
],
"age": {
"start": 1,
"end": 2
}
},
"days_offered": [
{
"id": 1,
"name": "Monday"
},
{
"id": 2,
"name": "Tuesday"
},
{
"id": 3,
"name": "Wednesday"
},
{
"id": 4,
"name": "Thursday"
},
{
"id": 5,
"name": "Friday"
}
],
"times": [
{
"start": "1900-01-01T08:00:00.0000000",
"end": "1900-01-01T09:00:00.0000000"
}
],
"scholarship": {
"enabled": false
},
"registration": {
"start": "2014-12-11T00:00:00.0000000",
"end": "2015-01-29T23:59:00.0000000",
"state": "open"
}
}
]
}
Get program offering details
Description
This call returns offerings for the different Daxko Operations program types as a common format. There are some notes specific to the different program types as follows:
For traditional programs or program packages:
- The
detailscollection is a list of segments associated with the {offering_id} details.namewill only have a value if the program type is a package salemax_daysproperty does not exist, as this only applies to child care and camp (maximum number of days that the rate plan pays for).
For child care programs:
- The
detailscollection will always have 1 item in the collection. - If the offering is a daily rate, then
details.rate.amountwill be null, and insteaddetails.rate.amountswill return a mapping of day to amount, whererate.amounts.idis the ISO 8601 representation of the day of the week. Example:
"rate": {
"frequency": "daily",
"amounts": [
{
"amount": 0,
"id": 1,
"name": "Monday"
},
{
"amount": 1,
"id": 3,
"name": "Wednesday"
},
{
"amount": 3,
"id": 5,
"name": "Friday"
}
],
...
}
For camp programs:
- The
detailscollection will always have 1 item in the collection. General notes: - On the
groups.registration_datescollection, none of the dates are translated to UTC. This will be the same date that is entered in the UI. Example, if the UI shows registration starting on 5/1/2020 at 8:15 AM, then the date in the response will be2020-05-01T08:15:00.0000000 - The
restrictions.gendersproperty will always exist and have the values of onlyM, onlyF, or the combination ofMandF. - The
restrictions.dobproperty will not exist if there is not a date of birth restriction - The
restrictions.ageproperty will not exist if there is not an age restriction - The
restrictions.expires_inproperty only exist for program packages that have an Expiration configured
Path Parameters
See /programs/{program_id}/offerings call for how to get program id.
See /programs/{program_id}/offerings call for how to get offering id.
Query Parameters
Example: B1234 would be branch with id 1234. S5678 would be site with 5678.
Responses
HTTP 200 OK
Offering id
Offering name
Offering description
Program Information
Program ID
Program Name
Restriction Information
Genders that registration is restricted to
Single character id of gender
M or F
Display friendly gender
Male or Female
Date of birth restriction. This property will not exist if there is no dob restriction.
Start date of birth
End date of birth
Age restriction. This property will not exist if there is no age restriction.
Start age range
End age range
Location offering occurs at
People associated with this location
Type of person
contact, instructor
Full name
Email address
Phone number
First street address line of location
Second street address line of location, if specified
City of location
State of location
Zip code of location
Categories that offering is a part of
Start date
End date
Display friendly description of when fee is due
Availability
If true, then there is a limit to number of seats available.
If true, there are no spots available.
If limited is true, then this property will exist and indicate the maximum number of seats. If limited is false, then this property will not exist.
Number of seats taken. (NOTE: For child care programs, this value is always -1 to indicate that the value is unavailable at this level since child care seat counts are calculated at the instance level once a registration has been started. You should use the registration_summaries.can_register flag to control whether a registration can be started.)
If limited is true, then this indicates the number of seats available. If limited is false, then this property does not exist. (NOTE: For child care programs, this value is always -1 to indicate that the value is unavailable at this level since child care seat counts are calculated at the instance level once a registration has been started. You should use the registration_summaries.can_register flag to control whether a registration can be started.)
If limited is true, then this indicates whether a waiting list is available once the maximum number of seats has been reached.
If has_waiting_list is true, then this indicates how many members
are on the waiting list.
If has_waiting_list is true, then this indicates whether the offering
should display the waiting list count. This is currently only available for
traditional program offerings.
Summary of registration status per registration type. All of these values can be derived from other values in this response, but these are here as a helpful shortcut to control a UI.
Registration type
online, in_house
Whether or not registration is allowed for any registration group as of the time the call was made. Useful to enable/disable a button to start a registration for this.
State of registration dates. If registration is open for any group, will return open.
open, closed, future
Human readable description of state of registration.
Program fee groups
ID of program fee group
Fee information
Fee amount
Frequency of rate
flat, weekly, bi_weekly, semi_monthly, monthly, daily
Deposit amount
Rules for applying deposit. Property will not exist if there is no deposit
first_instances, last_instances, each_instance
Unit that the amount is in.
, week, every other week, semi-monthly, month, day
Display friendly rate
$100.00/week
Registration Dates
Registration type
in_house, online
Registration start date (in local time of organization)
Thu Dec 31 2009 18:00:00 GMT-0600 (Central Standard Time)
Registration end date (in local time of organization)
Wed Jan 01 2020 17:59:00 GMT-0600 (Central Standard Time)
Days of week that are available
ISO8061 day of week (1 is Monday, 7 is Sunday)
Display Friendly day of week
Monday
Times that are available. The date part will always be 1900-01-01, so you should only care about the time portion.
Start time
Mon Jan 01 1900 09:00:00 GMT-0600 (Central Standard Time)
End time
Extra fees (registration fee, late fee)
Type of fee
registration_fee, late_fee
Display friendly description of fee
Registration Fee
Fee amount
12.5
Agreements that must be accepted during registration
Agreement ID
Name of agreement
Indicates if the offering is tax deductible
If true, the member is allowed to register and schedule the future balance based on the due date. If false, everything is due at time of registration.
The sport type of the offering (applicable only to 'TMP' type of program).
Boxing
Whether uniform ordering is enabled for the offering (applicable only to 'TMP' type of program).
true
The sub-type of the offering (applicable only to 'CMP' type of program).
resident_camp
resident_camp, day_camp
{
"id": "SES902274",
"name": "My session",
"description": "My session description",
"program": {
"id": "TMP60715",
"name": "My program",
"description": ""
},
"restrictions": {
"genders": [
{
"id": "M",
"name": "Male"
},
{
"id": "F",
"name": "Female"
}
],
"dob": {
"start": "2000-01-01T00:00:00.0000000",
"end": "2008-05-01T00:00:00.0000000"
},
"age": {
"start": 1,
"end": 2
}
},
"location": {
"id": "B1234",
"name": "My Branch",
"people": [
{
"type": "contact",
"name": "John Doe",
"email": "adsf@example.com",
"phone": "3334445555"
},
{
"type": "instructor",
"name": "Jane Doe",
"email": "jane@example.com",
"phone": "1112223333"
}
],
"address1": "123 Sesame Street",
"city": "Seattle",
"state": "WA",
"zip": "12345"
},
"categories": [
{
"id": "TAG988888",
"name": "My tag #1"
}
],
"details": [
{
"id": "SEG1708473",
"name": "",
"description": "",
"start": "2016-12-05T00:00:00.0000000",
"end": "2016-12-05T00:00:00.0000000",
"due": {
"description": "Due at Registration"
},
"registration_summaries": [
{
"type": "online",
"registration_dates_state": "future",
"can_register": false,
"description": "Opens in Future"
},
{
"type": "in_house",
"registration_dates_state": "open",
"can_register": true,
"description": "87 of 100 spots left"
}
],
"availability": {
"limited": true,
"full": false,
"max": 100,
"taken": 13,
"available": 87,
"has_waiting_list": true
},
"groups": [
{
"id": "FG78",
"name": "Program Member",
"rate": {
"amount": 100,
"frequency": "flat",
"deposit": 5,
"apply_deposit_to": "first_instances",
"unit": "",
"description": "$100.00"
},
"registration_dates": [
{
"type": "in_house",
"start": "2010-01-01T00:00:00.0000000",
"end": "2020-01-01T23:59:00.0000000"
},
{
"type": "online",
"start": "2010-01-01T00:00:00.0000000",
"end": "2020-01-01T23:59:00.0000000"
}
]
},
{
"id": "FG79",
"name": "Non-Members",
"rate": {
"amount": 100,
"frequency": "flat",
"deposit": 5,
"apply_deposit_to": "each_instance",
"unit": "",
"description": "$100.00"
},
"registration_dates": [
{
"type": "in_house",
"start": "2010-01-01T00:00:00.0000000",
"end": "2020-01-01T23:59:00.0000000"
},
{
"type": "online",
"start": "2010-01-01T00:00:00.0000000",
"end": "2020-01-01T23:59:00.0000000"
}
]
}
],
"days_offered": [
{
"id": 1,
"name": "Monday"
},
{
"id": 3,
"name": "Wednesday"
},
{
"id": 5,
"name": "Friday"
}
],
"times": [
{
"start": "1900-01-01T15:00:00.0000000",
"end": "1900-01-01T16:15:00.0000000"
}
]
},
{
"id": "SEG1708483",
"name": "",
"description": "",
"start": "2018-01-01T00:00:00.0000000",
"end": "2018-01-02T00:00:00.0000000",
"due": {
"description": "Due at Registration"
},
"availability": {
"limited": false,
"full": false,
"taken": 0
},
"groups": [
{
"id": "FG78",
"name": "Program Member",
"rate": {
"amount": 50,
"frequency": "flat",
"deposit": 5,
"unit": "",
"description": "$50.00"
},
"registration_dates": [
{
"type": "in_house",
"start": "2010-01-01T00:00:00.0000000",
"end": "2020-01-01T23:59:00.0000000"
},
{
"type": "online",
"start": "2010-01-01T00:00:00.0000000",
"end": "2020-01-01T23:59:00.0000000"
}
]
},
{
"id": "FG79",
"name": "Non-Members",
"rate": {
"amount": 50,
"frequency": "flat",
"deposit": 5,
"unit": "",
"description": "$50.00"
},
"registration_dates": [
{
"type": "in_house",
"start": "2010-01-01T00:00:00.0000000",
"end": "2020-01-01T23:59:00.0000000"
},
{
"type": "online",
"start": "2010-01-01T00:00:00.0000000",
"end": "2020-01-01T23:59:00.0000000"
}
]
}
],
"days_offered": [
{
"id": 1,
"name": "Monday"
},
{
"id": 3,
"name": "Wednesday"
},
{
"id": 5,
"name": "Friday"
}
],
"times": [
{
"start": "1900-01-01T15:00:00.0000000",
"end": "1900-01-01T16:15:00.0000000"
}
]
}
],
"fees": [
{
"type": "registration_fee",
"description": "Registration Fee",
"amount": 5
}
],
"agreements": [
{
"id": "W293",
"name": "The title of my agreement"
}
],
"tax_deductible": true,
"allow_online_payment_scheduling": true,
"sport_type": "Boxing",
"is_uniform_ordering_enabled": true,
"program_sub_type": "resident_camp"
}
List program categories
Description
This endpoints returns a list of program categories that meet the criteria.
Example:
/programs/categories?as_of={start:2010-01-01T08:00:00,end:2015-01-01T08:00:00,mode:registration_occurs_between}&locations=B123,B567&offering_types=rate_plan,camp_instance®istration_type=online&include_inactive_categories=true&limit=999
Query Parameters
Restricts the list of categories to have the specified start and end datetime
in at least one of the registration datetime ranges.
See As of date tutorial.
{ start:<datetime for request>, end:<datetime of request>, mode:registration_occurs_between, }{ start:2017-04-19T09:58:32, end:2017-04-23T09:58:32, mode:registration_occurs_between, }Restricts the list of categories to be associated with programs at the specified locations. If omitted, no location-based restrictions will be applied.
B27,S34Restricts the list of categories to only be associated with certain types of program offerings. If omitted, returns categories associated with all types of program offerings.
session, package, rate_plan, camp_instance
Restricts the list of categories to only be associated with in-house or online program offerings. Default behavior is to return categories for both in-house and online program offerings.
in_house, online
Indicates whether to show inactive categories. Default behavior will omit inactive categories.
falseIndicates whether to show categories associated with inactive locations. Defaultbehavior will omit categories associated with inactive locations.
falseRestricts results that occur within at least one of the date ranges.
[object Object],[object Object]Number of results to return.
100999Responses
HTTP 200 OK
A list of categories that meet the requested criteria.
The name of the category
The ID of the category
The number of offerings associated with this category
The number of programs associated with this category
Indicates if the category is active.
Indicates if the category is set to be visible online
The number of categories returned
The maximum number of items requested. This value is the same value as the limit query parameter on the request.
{
"categories": [
{
"name": "Swim",
"id": "TAG123",
"offering_count": 10,
"program_count": 5
},
{
"name": "Soccer",
"id": "TAG34",
"offering_count": 3,
"program_count": 3
},
{
"name": "After school care",
"id": "CAT99",
"offering_count": 20,
"program_count": 8
}
],
"total": 3,
"limit": 100
}
List program locations
Description
This endpoints returns a list of program locations that meet the criteria.
Example:
/programs/locations?as_of={start:2010-01-01T08:00:00,end:2015-01-01T08:00:00,mode:registration_occurs_between}&locations=B123,B567&offering_types=rate_plan,camp_instance®istration_type=online&include_inactive_locations=true&limit=999
Query Parameters
Restricts the list of locations to have the specified start and end datetime
in at least one of the registration datetime ranges.
See As of date tutorial.
{start:<datetime of request>,end:<datetime of request>,mode:registration_occurs_between}{start:2017-04-19T09:58:32,end:2017-04-23T09:58:32,mode:registration_occurs_between}Restricts the list of locations to be associated with programs that offers programs with the specified categories. If omitted, no category-based restrictions will be applied.
TAG27,CAT34Restricts the list of locations to only be associated with certain types of program offerings. If omitted, returns locations associated with all types of program offerings.
session, package, rate_plan, camp_instance
Restricts the list of locations to only be associated with in-house or online program offerings. Default behavior is to return locations for both in-house and online program offerings.
in_house, online
Indicates whether to show locations associated with inactive categories. Default behavior will omit locations associated with inactive categories. However, if an offering has an inactive category and at least one active category, its location will be returned.
falseIndicates whether to show inactive locations. Default behavior will omit inactive locations.
falseRestricts results that occur within at least one of the date ranges.
[ { start:2010-01-01, end:2011-01-01 }, { start:2015-01-01, end:2016-01-01 }, ]Number of results to return.
100999Responses
HTTP 200 OK
A list of locations that meet the requested criteria.
The name of the location
The ID of the location
The type of location
branch, site
The number of offerings associated with this location
The number of programs associated with this location
Indicates if the location is active.
Indicates if the location is set to be visible online
The number of locations returned
The maximum number of items requested. This value is the same value as the limit query parameter on the request.
{
"locations": [
{
"name": "Downtown Branch",
"id": "B392",
"type": "branch",
"offering_count": 10,
"program_count": 5
},
{
"name": "Childcare Site",
"id": "S9004",
"type": "site",
"offering_count": 3,
"program_count": 3
}
],
"total": 2,
"limit": 100
}
Get program offering's roster
Description
This call returns a list of participants associated with a given program offering.
Example:
/v3/programs/TMP63334/offerings/SES922827/roster?page_number=3&page_size=2®istered_after=30-04-2020&location_id=B38
Path Parameters
The ID of the program.
CMP4245232The ID of the offering.
RP4223252Query Parameters
The ID of the location (prefixed by B for branches or S for sites).
B38Filters to only include the participants that are registered after the provided date. The format for the date should be dd-mm-yyyy.
30-04-2020Optionally, whether to include details about the registered participant's unit, including contact information.
trueThe page number of the response. If not included in request, its default value will be 1.
11The number of units/results fetched per response, defaulting to 25.
2525Responses
HTTP 200 OK
The number of results returned on this page of the response.
1
The offering's list of members.
The unit ID of the member.
300180604
The member's first name.
Dobby
The member's last name.
Elf
The member's member ID.
300180604-01
The email address associated with the member.
dobby@daxko.com
The home phone number associated with the member.
(999) 123-4567
The mobile-phone number associated with the member.
(555) 555-5555
The member's birth date.
12/13/1933
The member's gender.
Female
The member's addition gender identity
The home address associated with the member.
The member's address.
123 Some Road
The member's address details, such as an apartment number.
F8
The member's city.
Blah
The member's state.
AL
The member's Zip code.
12345
The list of days on which the member is enrolled in the offering.
[{"id":1,"name":"Monday"},{"id":3,"name":"Wednesday"},{"id":4,"name":"Thursday"}]
The ID of the day of week. ID of Monday is 1 and Sunday is 7.
The name of the day of week.
Information about the primary member associated with the participant's unit, if requested.
The member's ID
123123-01
The member's name
The member's name prefix
Dr.
The member's first name
John
The member's middle name
Fitzgerald
The member's last name
Doe
The members' name suffix
III
A list of member phone numbers
The type of phone number
home
home, mobile, emergency
The area code or prefix of the phone number
555
The phone number
555-5555
The extension of the phone number
321
A list of member addresses
The type of email
default
default
A member's email address
jdoe@example.com
The timestamp at which the member was added to the roster. If the member is registered multiple times, only the latest registration timestamp will be shown.
2020-04-30T13:05:12.5200000
The ID of the offering registration. If the member is registered multiple times, only the latest registration ID will be shown.
345672
The list of segments for which the member has registered (only applicable for Standard and Package programs).
[{"id":"SEG1729036"},{"id":"SEG1729039"},{"id":"SEG1729040"}]
The ID of the segment (prefixed by SEG for segments).
Whether there are more records on the next page.
true
{
"total": 1,
"roster": [
{
"unit_id": "300180604",
"first_name": "Dobby",
"last_name": "Elf",
"member_id": "300180604-01",
"email": "dobby@daxko.com",
"home_phone": "(999) 123-4567",
"cellphone": "(555) 555-5555",
"birth_date": "12/13/1933",
"gender": "Female",
"gender_info": "",
"home_address": {
"address1": "123 Some Road",
"address2": "F8",
"city": "Blah",
"state": "AL",
"zip": "12345"
},
"days": [
{
"id": 1,
"name": "Monday"
},
{
"id": 3,
"name": "Wednesday"
},
{
"id": 4,
"name": "Thursday"
}
],
"unit_details": {
"member_id": "123123-01",
"name": {
"prefix": "Dr.",
"first_name": "John",
"middle_name": "Fitzgerald",
"last_name": "Doe",
"suffix": "III"
},
"phones": [
{
"type": "home",
"area_code": "555",
"number": "555-5555",
"extension": "321"
}
],
"emails": [
{
"type": "default",
"email": "jdoe@example.com"
}
]
},
"registration_date": "2020-04-30T13:05:12.5200000",
"registration_id": 345672,
"segments": [
{
"id": "SEG1729036"
},
{
"id": "SEG1729039"
},
{
"id": "SEG1729040"
}
]
}
],
"has_more_records": true
}
Get program offering's roster of only a particular participating member
Description
This call returns a list of different registrations done for a particular member that is enrolled in the program offering. Each registration unit here includes the responses of questions asked, list of week days that were opted by the member for the offering (if applicable) and the list of segments that were selected (applicable only to standard type of program) by the member in this particular registration, when it was done.
Example:
/v3/programs/TMP63334/offerings/SES922827/roster/300180604-01?page_number=1&page_size=3®istered_after=01-04-2020
Path Parameters
The ID of the program.
TMP4245232The ID of the offering.
SES4223252The ID of the member whose roster we need to fetch.
300180604-01Query Parameters
Filters to only include the registration units that are registered after the provided date. The format for the date should be dd-mm-yyyy.
30-04-2020Optionally, whether to include details about the registered participant's unit, including contact information.
trueThe page number of the response. If not included in request, its default value will be 1.
1The number of units/results fetched per response, defaulting to 25.
25Responses
HTTP 200 OK
The number of results returned on this page of the response.
1
The offering's list of registration units of the member.
The unit ID of the member.
300180604
The member's first name.
Dobby
The member's last name.
Elf
The member's member ID.
300180604-01
The email address associated with the member.
dobby@daxko.com
The home phone number associated with the member.
(999) 123-4567
The mobile-phone number associated with the member.
(555) 555-5555
The member's birth date.
12/13/1933
The member's gender.
Female
The member's addition gender identity
The home address associated with the member.
The member's address.
123 Some Road
The member's address details, such as an apartment number.
F8
The member's city.
Blah
The member's state.
AL
The member's Zip code.
12345
The list of days on which the member is enrolled in the offering.
[{"id":1,"name":"Monday"},{"id":3,"name":"Wednesday"},{"id":4,"name":"Thursday"}]
The ID of the day of week. ID of Monday is 1 and Sunday is 7.
The name of the day of week.
Information about the primary member associated with the participant's unit, if requested.
The member's ID
123123-01
The member's name
The member's name prefix
Dr.
The member's first name
John
The member's middle name
Fitzgerald
The member's last name
Doe
The members' name suffix
III
A list of member phone numbers
The type of phone number
home
home, mobile, emergency
The area code or prefix of the phone number
555
The phone number
555-5555
The extension of the phone number
321
A list of member addresses
The type of email
default
default
A member's email address
jdoe@example.com
The timestamp at which this registration was done.
2020-05-08T17:59:40.2100000
The ID of the offering registration.
345672
The ID of branch or site of the offering where the member is enrolled (prefixed by B for branches or S for sites).
B38
The list of segments that are associated with this registration (only applicable for Standard and Package programs).
[{"id":"SEG1729036","start_date":"2021-01-31T00:00:00.000Z","end_date":"2021-08-31T00:00:00.000Z"},{"id":"SEG1729039","start_date":"2021-09-01T00:00:00.000Z","end_date":"2021-12-31T00:00:00.000Z"}]
The ID of the segment (prefixed by SEG for segments).
The start date of the segment for which the member is registered. This is only applicable for Standard programs.
The end date of the segment for which the member is registered. This is only applicable for Standard programs.
The questions and answers associated with this registration.
[{"question":"Home Address","answer":{"line1":"123 Some Road","line2":"","city":"Blah","state":"AL","intl_province_region":"AL","ca_province":"AL","zip":"12345","intl_zip":"12345","country":"US"},"question_id":234312,"question_type":"address","cart_question_id":"program_address-216002","answer_display_value":{"line1":"123 Some Road","line2":"","city":"Blah","state":"AL","intl_province_region":"AL","ca_province":"AL","zip":"12345","intl_zip":"12345","country":"US"}},{"question":"Marital Status","answer":"M","question_id":216003,"question_type":"dropdown","cart_question_id":"program_maritalstatus-216003","answer_display_value":"Married"}]
The question for the registration.
The answer provided during the registration.
The ID of the question.
The type of the question.
text, name, date, dropdown, radio, checkboxes, phone, address, email, password, textarea, datetime
The ID of the question, as it would appear in the get-custom-questions endpoint response.
The friendly display value of the answer.
The list of date ranges for which the member is registered. This is only applicable for ChildCare and Camp programs.
[{"start_date":"2020-01-01T00:00:00.000Z","end_date":"2020-01-01T00:00:00.000Z"},{"start_date":"2020-01-06T00:00:00.000Z","end_date":"2020-01-06T00:00:00.000Z"}]
The start date of the range for which the member is registered.
The end date of the range for which the member is registered.
Whether there are more records on the next page.
true
{
"total": 1,
"roster": [
{
"unit_id": "300180604",
"first_name": "Dobby",
"last_name": "Elf",
"member_id": "300180604-01",
"email": "dobby@daxko.com",
"home_phone": "(999) 123-4567",
"cellphone": "(555) 555-5555",
"birth_date": "12/13/1933",
"gender": "Female",
"gender_info": "",
"home_address": {
"address1": "123 Some Road",
"address2": "F8",
"city": "Blah",
"state": "AL",
"zip": "12345"
},
"days": [
{
"id": 1,
"name": "Monday"
},
{
"id": 3,
"name": "Wednesday"
},
{
"id": 4,
"name": "Thursday"
}
],
"unit_details": {
"member_id": "123123-01",
"name": {
"prefix": "Dr.",
"first_name": "John",
"middle_name": "Fitzgerald",
"last_name": "Doe",
"suffix": "III"
},
"phones": [
{
"type": "home",
"area_code": "555",
"number": "555-5555",
"extension": "321"
}
],
"emails": [
{
"type": "default",
"email": "jdoe@example.com"
}
]
},
"registration_date": "2020-05-08T17:59:40.2100000",
"registration_id": 345672,
"location_id": "B38",
"segments": [
{
"id": "SEG1729036",
"start_date": "2021-01-31T00:00:00.0000000",
"end_date": "2021-08-31T00:00:00.0000000"
},
{
"id": "SEG1729039",
"start_date": "2021-09-01T00:00:00.0000000",
"end_date": "2021-12-31T00:00:00.0000000"
}
],
"questions_answers": [
{
"question": "Home Address",
"answer": {
"line1": "123 Some Road",
"line2": "",
"city": "Blah",
"state": "AL",
"intl_province_region": "AL",
"ca_province": "AL",
"zip": "12345",
"intl_zip": "12345",
"country": "US"
},
"question_id": 234312,
"question_type": "address",
"cart_question_id": "program_address-216002",
"answer_display_value": {
"line1": "123 Some Road",
"line2": "",
"city": "Blah",
"state": "AL",
"intl_province_region": "AL",
"ca_province": "AL",
"zip": "12345",
"intl_zip": "12345",
"country": "US"
}
},
{
"question": "Marital Status",
"answer": "M",
"question_id": 216003,
"question_type": "dropdown",
"cart_question_id": "program_maritalstatus-216003",
"answer_display_value": "Married"
}
],
"registered_dates": [
{
"instance_id": "CCI1234",
"start_date": "2020-01-01T00:00:00.0000000",
"end_date": "2020-01-01T00:00:00.0000000"
},
{
"instance_id": "CCI2345",
"start_date": "2020-01-06T00:00:00.0000000",
"end_date": "2020-01-06T00:00:00.0000000"
}
]
}
],
"has_more_records": true
}
Get program offering's waitlisted roster
Description
This call returns a list of waitlisted members associated with a given program offering.
Example:
/v3/programs/TMP63334/offerings/SES922827/waitlist?page_number=1&page_size=5&location_id=B38®istered_after=30-04-2020
Path Parameters
The ID of the program.
CMP4245232The ID of the offering.
RP4223252Query Parameters
The ID of the location (prefixed by B for branches or S for sites).
B38Whether to only include waitlisted members who registered after provided date. The format for the date should be dd-mm-yyyy.
30-04-2020Optionally, whether to include details about the registered participant's unit, including contact information.
trueThe page number of the response. If not included in request, its default value will be 1.
1The number of units/results fetched per response, defaulting to 25.
25Responses
HTTP 200 OK
The number of results returned on this page of the response.
1
The offering's list of waitlisted members.
The unit ID of the member.
300180604
The member's first name.
Dobby
The member's last name.
Elf
The member's member ID.
300180604-01
The email address associated with the member.
dobby@daxko.com
The home phone number associated with the member.
(999) 123-4567
The mobile-phone number associated with the member.
(555) 555-5555
The member's birth date.
12/13/1933
The member's gender.
Female
The member's addition gender identity
The home address associated with the member.
The member's address.
123 Some Road
The member's address details, such as an apartment number.
F8
The member's city.
Blah
The member's state.
AL
The member's Zip code.
12345
The list of days on which the member is enrolled in the offering.
[{"id":1,"name":"Monday"},{"id":3,"name":"Wednesday"},{"id":4,"name":"Thursday"}]
The ID of the day of week. ID of Monday is 1 and Sunday is 7.
The name of the day of week.
Information about the primary member associated with the participant's unit, if requested.
The member's ID
123123-01
The member's name
The member's name prefix
Dr.
The member's first name
John
The member's middle name
Fitzgerald
The member's last name
Doe
The members' name suffix
III
A list of member phone numbers
The type of phone number
home
home, mobile, emergency
The area code or prefix of the phone number
555
The phone number
555-5555
The extension of the phone number
321
A list of member addresses
The type of email
default
default
A member's email address
jdoe@example.com
The timestamp at which the member was added to the roster. If the member is registered multiple times, only the latest registration timestamp will be shown.
2020-04-30T13:05:12.5200000
The ID of the offering registration. If the member is registered multiple times, only the latest registration ID will be shown.
345672
The list of segments for which the member has registered (only applicable for Standard and Package programs).
[{"id":"SEG1729036"},{"id":"SEG1729039"},{"id":"SEG1729040"}]
The ID of the segment (prefixed by SEG for segments).
Whether there are more records on the next page.
true
{
"total": 1,
"roster": [
{
"unit_id": "300180604",
"first_name": "Dobby",
"last_name": "Elf",
"member_id": "300180604-01",
"email": "dobby@daxko.com",
"home_phone": "(999) 123-4567",
"cellphone": "(555) 555-5555",
"birth_date": "12/13/1933",
"gender": "Female",
"gender_info": "",
"home_address": {
"address1": "123 Some Road",
"address2": "F8",
"city": "Blah",
"state": "AL",
"zip": "12345"
},
"days": [
{
"id": 1,
"name": "Monday"
},
{
"id": 3,
"name": "Wednesday"
},
{
"id": 4,
"name": "Thursday"
}
],
"unit_details": {
"member_id": "123123-01",
"name": {
"prefix": "Dr.",
"first_name": "John",
"middle_name": "Fitzgerald",
"last_name": "Doe",
"suffix": "III"
},
"phones": [
{
"type": "home",
"area_code": "555",
"number": "555-5555",
"extension": "321"
}
],
"emails": [
{
"type": "default",
"email": "jdoe@example.com"
}
]
},
"registration_date": "2020-04-30T13:05:12.5200000",
"registration_id": 345672,
"segments": [
{
"id": "SEG1729036"
},
{
"id": "SEG1729039"
},
{
"id": "SEG1729040"
}
]
}
],
"has_more_records": true
}
Get program offering's roster of only a particular waitlisted member
Description
This call returns a list of different registrations done for a particular waitlisted member that is enrolled in the program offering. Each registration unit here includes the responses of questions asked, list of week days that were opted by the member for the offering (if applicable) and the list of segments that were selected (applicable only to standard type of program) by the member in this particular registration, when it was done.
Example:
/v3/programs/TMP63334/offerings/SES922827/waitlist/300180263-02?registered_after=24-04-2020&page_number=1&page_size=2
Path Parameters
The ID of the program.
TMP4245232The ID of the offering.
SES4223252The ID of the member whose roster we need to fetch.
300180604-01Query Parameters
Filters to only include the registration units that are registered after the provided date. The format for the date should be dd-mm-yyyy.
30-04-2020Optionally, whether to include details about the registered participant's unit, including contact information.
trueThe page number of the response. If not included in request, its default value will be 1.
1The number of units/results fetched per response, defaulting to 25.
25Responses
HTTP 200 OK
The number of results returned on this page of the response.
1
The offering's list of waitlisted registration units of the member.
The unit ID of the member.
300180604
The member's first name.
Dobby
The member's last name.
Elf
The member's member ID.
300180604-01
The email address associated with the member.
dobby@daxko.com
The home phone number associated with the member.
(999) 123-4567
The mobile-phone number associated with the member.
(555) 555-5555
The member's birth date.
12/13/1933
The member's gender.
Female
The member's addition gender identity
The home address associated with the member.
The member's address.
123 Some Road
The member's address details, such as an apartment number.
F8
The member's city.
Blah
The member's state.
AL
The member's Zip code.
12345
The list of days on which the member is enrolled in the offering.
[{"id":1,"name":"Monday"},{"id":3,"name":"Wednesday"},{"id":4,"name":"Thursday"}]
The ID of the day of week. ID of Monday is 1 and Sunday is 7.
The name of the day of week.
Information about the primary member associated with the participant's unit, if requested.
The member's ID
123123-01
The member's name
The member's name prefix
Dr.
The member's first name
John
The member's middle name
Fitzgerald
The member's last name
Doe
The members' name suffix
III
A list of member phone numbers
The type of phone number
home
home, mobile, emergency
The area code or prefix of the phone number
555
The phone number
555-5555
The extension of the phone number
321
A list of member addresses
The type of email
default
default
A member's email address
jdoe@example.com
The timestamp at which this registration was done.
2020-05-08T17:59:40.2100000
The ID of the offering registration.
345672
The ID of branch or site of the offering where the member is enrolled (prefixed by B for branches or S for sites).
B38
The list of segments that are associated with this registration (only applicable for Standard and Package programs).
[{"id":"SEG1729036","start_date":"2021-01-31T00:00:00.000Z","end_date":"2021-08-31T00:00:00.000Z"},{"id":"SEG1729039","start_date":"2021-09-01T00:00:00.000Z","end_date":"2021-12-31T00:00:00.000Z"}]
The ID of the segment (prefixed by SEG for segments).
The start date of the segment for which the member is registered. This is only applicable for Standard programs.
The end date of the segment for which the member is registered. This is only applicable for Standard programs.
The questions and answers associated with this registration.
[{"question":"Home Address","answer":{"line1":"123 Some Road","line2":"","city":"Blah","state":"AL","intl_province_region":"AL","ca_province":"AL","zip":"12345","intl_zip":"12345","country":"US"},"question_id":234312,"question_type":"address","cart_question_id":"program_address-216002","answer_display_value":{"line1":"123 Some Road","line2":"","city":"Blah","state":"AL","intl_province_region":"AL","ca_province":"AL","zip":"12345","intl_zip":"12345","country":"US"}},{"question":"Marital Status","answer":"M","question_id":216003,"question_type":"dropdown","cart_question_id":"program_maritalstatus-216003","answer_display_value":"Married"}]
The question for the registration.
The answer provided during the registration.
The ID of the question.
The type of the question.
text, name, date, dropdown, radio, checkboxes, phone, address, email, password, textarea, datetime
The ID of the question, as it would appear in the get-custom-questions endpoint response.
The friendly display value of the answer.
The list of date ranges for which the member is registered. This is only applicable for ChildCare and Camp programs.
[{"start_date":"2020-01-01T00:00:00.000Z","end_date":"2020-01-01T00:00:00.000Z"},{"start_date":"2020-01-06T00:00:00.000Z","end_date":"2020-01-06T00:00:00.000Z"}]
The start date of the range for which the member is registered.
The end date of the range for which the member is registered.
Whether there are more records on the next page.
true
{
"total": 1,
"roster": [
{
"unit_id": "300180604",
"first_name": "Dobby",
"last_name": "Elf",
"member_id": "300180604-01",
"email": "dobby@daxko.com",
"home_phone": "(999) 123-4567",
"cellphone": "(555) 555-5555",
"birth_date": "12/13/1933",
"gender": "Female",
"gender_info": "",
"home_address": {
"address1": "123 Some Road",
"address2": "F8",
"city": "Blah",
"state": "AL",
"zip": "12345"
},
"days": [
{
"id": 1,
"name": "Monday"
},
{
"id": 3,
"name": "Wednesday"
},
{
"id": 4,
"name": "Thursday"
}
],
"unit_details": {
"member_id": "123123-01",
"name": {
"prefix": "Dr.",
"first_name": "John",
"middle_name": "Fitzgerald",
"last_name": "Doe",
"suffix": "III"
},
"phones": [
{
"type": "home",
"area_code": "555",
"number": "555-5555",
"extension": "321"
}
],
"emails": [
{
"type": "default",
"email": "jdoe@example.com"
}
]
},
"registration_date": "2020-05-08T17:59:40.2100000",
"registration_id": 345672,
"location_id": "B38",
"segments": [
{
"id": "SEG1729036",
"start_date": "2021-01-31T00:00:00.0000000",
"end_date": "2021-08-31T00:00:00.0000000"
},
{
"id": "SEG1729039",
"start_date": "2021-09-01T00:00:00.0000000",
"end_date": "2021-12-31T00:00:00.0000000"
}
],
"questions_answers": [
{
"question": "Home Address",
"answer": {
"line1": "123 Some Road",
"line2": "",
"city": "Blah",
"state": "AL",
"intl_province_region": "AL",
"ca_province": "AL",
"zip": "12345",
"intl_zip": "12345",
"country": "US"
},
"question_id": 234312,
"question_type": "address",
"cart_question_id": "program_address-216002",
"answer_display_value": {
"line1": "123 Some Road",
"line2": "",
"city": "Blah",
"state": "AL",
"intl_province_region": "AL",
"ca_province": "AL",
"zip": "12345",
"intl_zip": "12345",
"country": "US"
}
},
{
"question": "Marital Status",
"answer": "M",
"question_id": 216003,
"question_type": "dropdown",
"cart_question_id": "program_maritalstatus-216003",
"answer_display_value": "Married"
}
],
"registered_dates": [
{
"instance_id": "CCI1234",
"start_date": "2020-01-01T00:00:00.0000000",
"end_date": "2020-01-01T00:00:00.0000000"
},
{
"instance_id": "CCI2345",
"start_date": "2020-01-06T00:00:00.0000000",
"end_date": "2020-01-06T00:00:00.0000000"
}
]
}
],
"has_more_records": true
}
Get Program Attendance
Description
This call returns the attendance of members registered in a program within a given date range.
Example:
/v3/programs/CMP4245231/attendance?location_id=B38&start_date=16-03-2020&end_date=22-03-2020
Path Parameters
The ID of the program.
CMP4245231Query Parameters
The ID of the location (prefixed by B for branches or S for sites).
B38The start date for the date range.
31-01-2020The end date for the date range.
31-12-2020Responses
HTTP 200 OK
The number of members returned
1
The members who attended during the specified date range.
The member's Unit ID.
300179833
The member's Member ID.
300179833-01
The dates the participant attended.
Date
31-01-2020
The time the participant checked in.
05:00:00
The time the participant checked out.
09:00:00
{
"total": 2,
"members": [
{
"unit_id": "300180543",
"member_id": "300180543-01",
"attendance": [
{
"date": "2020-03-16",
"time_in": "04:58:00",
"time_out": "21:00:00"
},
{
"date": "2020-03-17",
"time_in": "05:00:00",
"time_out": "21:00:00"
},
{
"date": "2020-03-18",
"time_in": "05:00:00",
"time_out": "21:00:00"
},
{
"date": "2020-03-19",
"time_in": "05:00:00",
"time_out": "17:00:00"
},
{
"date": "2020-03-20",
"time_in": "05:00:00",
"time_out": "17:00:00"
}
]
},
{
"unit_id": 300180543,
"member_id": "300180543-03",
"attendance": [
{
"date": "2020-03-16",
"time_in": "04:53:00",
"time_out": "04:54:00"
},
{
"date": "2020-03-17",
"time_in": "10:00:00",
"time_out": "17:00:00"
},
{
"date": "2020-03-18",
"time_in": "10:00:00",
"time_out": "17:00:00"
},
{
"date": "2020-03-19",
"time_in": "10:00:00",
"time_out": "17:00:00"
},
{
"date": "2020-03-20",
"time_in": "10:00:00",
"time_out": "17:00:00"
}
]
}
]
}
Check in member to program
Description
This call checks in a member at the given date and time to a childcare or camp program.
Example request body:
{
"member_id" : "90000059443-01",
"location_id" : "B38",
"date" : "2020-04-13",
"time" : "15:48"
}
Path Parameters
The ID of the program.
CMP4245232Request Body
The ID of the location (prefixed by B for branches or S for sites).
B38
The member ID of the registrant to be checked in.
90000059443-01
The check-in date.
2020-04-13
The check-in time.
15:48
Responses
HTTP 201 Created
HTTP 400 Bad Request
HTTP 500 Internal Server Error
Check out member from program
Description
This call checks out a member at the given date and time from a childcare or camp program.
Example request body:
{
"member_id" : "90000059443-01",
"location_id" : "B38",
"date" : "2020-04-13",
"time" : "15:48"
}
Path Parameters
The ID of the program.
CMP4245232Request Body
The ID of the location (prefixed by B for branches or S for sites).
B38
The member ID of the registrant to be checked out.
90000059443-01
The check-out date.
2020-04-13
The check-out time.
15:48
Responses
HTTP 201 Created
HTTP 400 Bad Request
HTTP 500 Internal Server Error
Get Program Offering Eligibility
Description
Determines whether a member is eligible to register for a program offering without the need to try to create a registration. This allows eligibility to be confirmed without decrementing availability, by checking the registration dates as well as the member's membership type, status, gender and age (or date of birth) against the offering setup. Please note that this resource does not confirm availability and that it is only valid for standard and package programs.
Path Parameters
The ID of the program.
TMP4245232The ID of the offering.
SES4223252Query Parameters
The ID of the member.
300180604-01Responses
HTTP 200 OK
Whether the member can register for the offering/program.
false
The list of reasons why member cannot register. If the can_register property is true, this list will be empty.
The reason for the restriction.
GENDER_RESTRICTED
AGE_RESTRICTED, BIRTHDATE_RESTRICTED, GENDER_RESTRICTED, REGISTRATION_DATE_RESTRICTED, FEE_GROUP_RESTRICTED
Details about the reason.
Registration is not allowed for male members
Get Program Eligibility
Description
Determines whether a member is eligible to register for a program offering without the need to try to create a registration. This allows eligibility to be confirmed without decrementing availability, by checking the registration dates as well as the member's membership type, status, gender and age (or date of birth) against the offering setup. Please note that this resource does not confirm availability and that it is only valid for childcare and camp programs.
Path Parameters
The ID of the program.
CMP4245232Query Parameters
The ID of the member.
300180604-01Responses
HTTP 200 OK
Whether the member can register for the offering/program.
false
The list of reasons why member cannot register. If the can_register property is true, this list will be empty.
The reason for the restriction.
GENDER_RESTRICTED
AGE_RESTRICTED, BIRTHDATE_RESTRICTED, GENDER_RESTRICTED, REGISTRATION_DATE_RESTRICTED, FEE_GROUP_RESTRICTED
Details about the reason.
Registration is not allowed for male members
Prospects
The Prospects API allows the management of an organization's prospects.
Prospect Search
Description
This endpoint allows for searching of an association's prospects. Please be aware that there may be a delay of up to 5 minutes between when changes take place in Daxko Operations and the time they are reflected in this endpoint.
Query Parameters
The prospect's name.
Finch, Atticus or FinchThe prospect's phone number.
(555) 555-5555The prospect's email address.
atticus.finch@example.comWhether to filter results to those that have been modified after the provided UTC timestamp
2020-07-26T19:35:26ZThe page over which to iterate records.
11The number of items to return.
100100Responses
HTTP 200 OK
The list of prospects.
The ID of the prospect
PS123
The first name of the prospect
Atticus
The last name of the prospect
Finch
The email address of the prospect
atticus.finch@example.com
The phone number of the prospect
(555) 555-5555
The first line of the prospect's address
123 Main Street
The second line of the prospect's address
Suite 321
The prospect's city
Maycomb
The prospect's state
AL
The prospect's zipcode
35209
The prospect's country
USA
The birth date of the prospect
1920-01-01T00:00:00Z
The gender of the prospect
Male
The branch the prospect was first entered into
The ID of the source branch of the prospect
B27
The name of the source branch of the prospect
Downtown Branch
The date the prospect record was last updated
2020-06-21T17:28:46Z
Whether there are more results available.
false
The total number of records returned.
1
Add prospect
Description
Add a new prospect. Please note that this operation will first verify whether an individual with a matching name and contact information was already in the system. If that is the case, no insert will be performed and the existing record ID will be returned.
Request Body
The ID of the prospect's source.
PS1
The ID of the source branch of the prospect.
B38
The first name of the prospect.
Steve
The last name of the prospect.
Rogers
The email address of the prospect
steve.rogers@example.com
The phone number of the prospect
(555) 555-5555
The ID of the prospect's tour guide. Required if source_id = "PS1"
TG3
The ID of the prospect event. This property is required if the source_id property is PS2.
PE2
The first line of the prospect's address.
123 Main Street
The second line of the prospect's address.
Suite 321
The prospect's city.
Maycomb
The prospect's state.
AL
The prospect's Zip code.
35209
The prospect's country.
USA
The birth date of the prospect.
1920-01-01
The gender of the prospect.
M
M, F, U
The member's addition gender identity
The ID of the branch that the prospect is interested in.
B33
The ID of the membership type that the prospect is interested in.
MT41
Optionally, any notes to be included with the prospect's profile.
A test note
Responses
HTTP 201 Created
The ID of the prospect.
P123
If this property is returned as true, it signifies that an individual with a matching name and contact information was already in the system and was thus not inserted. Otherwise, this will be false.
true
Get prospects details
Description
Retrieves detailed information about a specific prospect.
Path Parameters
The ID of the prospect
Responses
HTTP 200 OK
The ID of the prospect
123
The first name of the prospect
Atticus
The last name of the prospect
Finch
The email address of the prospect
atticus.finch@example.com
The phone number of the prospect
(555) 555-5555
The first line of the prospect's address
123 Main Street
The second line of the prospect's address
Suite 321
The prospect's city
Maycomb
The prospect's state
AL
The prospect's zipcode
35209
The prospect's country
USA
The birth date of the prospect
1920-01-01T00:00:00Z
The date the prospect record was created
2020-06-20T17:28:46Z
The date the prospect record was last updated
2020-06-21T17:28:46Z
The date when the prospect was sourced
2020-06-19T17:28:46Z
The referral source for the prospect
The ID of the prospect's source
1
The name of the prospect's source
Scout
The gender of the prospect
Male
The member's addition gender identity
The date when the prospect toured a branch
2020-06-22T17:28:46Z
The tour guide associated to the prospect
The ID of the prospect's tour guide
3
The name of the prospect's tour guide
Boo Radley
The branch the prospect was first entered into
The ID of the source branch of the prospect
3
The name of the source branch of the prospect
Downtown Branch
The branch the prospect is interested in joining
The ID of the branch that the prospect is interested in
3
The name of the branch that the prospect is interested in
Downtown Branch
The type of membership the prospect is interested in
The ID of the membership type that the prospect is interested in
41
The name of the membership type that the prospect is interested in
Active Attorneys
The ID of the member who referred the prospect
532423-01
Details about the event associated with the prospect
The ID of the prospect event
2
The name of the prospect event
Lead
The staff member associated with the prospect
The ID of the staff member associated with the prospect
4
The name of the staff member associated with the prospect
Boo Radley
The status of the scheduled tour
The ID of the tour status for the prospect
1
The name of the tour status for the prospect
Pending
The status of the opportunity
The ID of the prospect's opportunity status
1
The ID of the prospect's opportunity status
Open
Optionally, the reason why the prospect did not join
The ID of the prospect's objection reason
4
The name of the prospect's objection reason
The fight for equal justice does not leave enough free time for the prospect
Update prospect
Description
Updates prospect information. Optional fields that are not supplied will be nullify.
Path Parameters
The ID of the prospect
P1435Request Body
The first name of the prospect.
Steve
The last name of the prospect.
Rogers
The email address of the prospect.
steve.rogers@example.com
The phone number of the prospect.
(555) 555-5555
The birth date of the prospect.
1920-01-01
The gender of the prospect.
M
M, F, U
The member's addition gender identity.
The first line of the prospect's address.
123 Main Street
The second line of the prospect's address.
Suite 321
The prospect's city.
Maycomb
The prospect's state.
AL
The prospect's Zip code.
35209
The prospect's country.
USA
The branch the prospect is interested in joining
The ID of the branch that the prospect is interested in
B33
The type of membership the prospect is interested in
The ID of the membership type that the prospect is interested in
MT41
The status of the tour
The ID of the tour status for the prospect
TS1
The tour guide associated to the prospect
The ID of the prospect's tour guide. Required if tour_status_id is "TS2" or "TS5"
TG13151
The tour date. Required if tour_status_id is "TS2" or "TS5"
2022-01-01
Responses
HTTP 204 No Content
Delete Prospect
Description
Deletes a prospect by ID.
Path Parameters
The ID of the prospect (prefixed by P).
P2321Responses
HTTP 204 No Content
Get prospect notes
Description
Retrieves the notes for the given prospect.
Path Parameters
The ID of the prospect.
300180263Responses
HTTP 200 OK
The list of notes for the prospect.
The ID of the note.
2086610
The text content of the note.
This is a new note
The date the note was created.
2020-10-06
The date the note was last updated.
2020-10-06
The name of the user who created the note.
Steven Williams
The name of the user who last updated the note.
Steven W
Create or update a note for a prospect
Description
Creates a new or updates an existing note for a prospect.
Path Parameters
The ID of the prospect.
23346654The ID of the an existing note to update. A new note is created if prospect_note_id is not provided.
23Request Body
The content of the note.
I have updated the note.
The the name of the user creating or updating the note.'
Steven W
Responses
HTTP 200 OK
Indicates whether the create or update was successful.
true
The ID of the note that was created or updated.
1213
List tour statuses
Description
This endpoint returns a list of tour statuses.
Responses
HTTP 200 OK
The list of tour statuses
ID of the tour status
TS1
Display name of the tour status.
Has not toured
List tour guides
Description
This endpoint returns a list of tour guides.
Responses
HTTP 200 OK
The list of tour guides
ID of the tour guide.
TG1
First name of the tour guide.
John
Last name of the tour guide.
Doe
List Events
Description
This endpoint returns a list of events.
Responses
HTTP 200 OK
The list of events
ID of the event.
PS1
Display name of the event.
Fall Festival
Archived status of the event.
False
List sources
Description
This endpoint returns a list of sources.
Responses
HTTP 200 OK
The list of sources
ID of the source
PS1
Display name of the source.
Tour
Scheduling
The Scheduling API allows developers to manage the services, appointments and other scheduling features for Daxko Operations. Please note this is an additional module for Daxko Operations customers and not all clients may have it.
List Branches for Scheduling a Visit
Description
Retrieves a list of available branches that have been setup for scheduling a visit.
Query Parameters
The registration type for which the available branches should be fetched.
in_houseonlinein_house, online
If provided, this will filter the branches by their address.
CaliforniaResponses
HTTP 200 OK
The total number of branches.
1
The list of branches.
The ID of the branch.
B42
The name of the branch.
Downtown Branch
The branch's address.
123 Main Street
The branch's secondary address, if available.
Suite 600
The branch's city.
Birmingham
The branch's state.
AL
The branch's postal code.
35209
The branch's country
USA
Whether the branch is configured to show to members online.
true
A unique identifier for branch created by the client.
MW1
The phone number of the branch.
(205) 658-8956
The branch's configured branch hours
Whether the branch hours are configured.
Whether the branch is open or closed and when that status will change.
List of Open and Close times per day of the week for the branch.
List of Branch Hours exceptions and their availability
Get Branch and Area Reservation Settings
Description
Retrieves the reservation settings of a branch and areas (only that are available for reservation) within it.
Path Parameters
The ID of the branch.
B42Responses
HTTP 200 OK
The name of the branch.
Downtown Branch
Whether visits to the branch can be scheduled in-house.
true
Whether visits to the branch can be scheduled online.
false
The maximum number of reservations a member can have for this branch.
5
The default minimum duration, in minutes, of a visit.
30
The default maximum duration, in minutes, of a visit.
60
The earliest, in minutes, a person can arrive before the scheduled time.
15
The time, in minutes, after the scheduled time when the check-in stops and the reservation is forfeited.
20
The list of reservation areas with settings available in the branch.
The ID of the area.
A14
The name of the area.
Area_1
Whether the area provides child-watch.
true
Whether the area has an age restriction.
true
The youngest a member can be to be allowed in the area.
8
The oldest a member can be to be allowed in the area.
14
Whether the capacity-tracking feature is enabled for the area.
false
The maximum capacity of the area.
70
The minimum duration, in minutes, of a visit.
30
The maximum duration, in minutes, of a visit.
60
Whether a reservation can only be made at the top of the hour or at any time.
top_of_hour
top_of_hour, any
Any notes associated with the reservation.
Please arrive on time!
Whether only children with an active membership should be allowed, if the area is a child-watch area.
false
The number of minutes after which a member would be automatically checked out (applicable only when the area is not a child-watch area).
10
Get Time Slot Availability for Scheduling Visit
Description
Retrieves the details of areas with time slot availability for scheduling a visit.
Path Parameters
The ID of the branch.
B12Query Parameters
The area IDs for which the availability should be fetched.
A1,A2The date for which the availablility needs to be fetched.
2021-03-31The start time from when the availablility needs to be fetched in 24 hr ISO format (hh:mm).
10:00The end time up to when the availablility needs to be fetched in 24 hr ISO format (hh:mm). If not provided, it will default to the end of the day.
15:00Responses
HTTP 200 OK
The list of areas with time slots and availability.
The ID of the area.
A1
The name of the area.
ABC Area
The maximum capacity of the area.
10
Whether the capacity-tracking feature is enabled for the area.
true
The minimum duration in minutes for which the slot can be booked in the area.
60
The maximum duration in minutes for which the slot can be booked in the area.
90
Whether the booking is allowed anytime or only at the top of the hour.
any
top_of_hour, any
A list of available time slots.
The slot header of the time slot in 24 hr ISO format (hh:mm).
10:00
The start time of the time slot in 24 hr ISO format (hh:mm).
10:00
The end time of the time slot in 24 hr ISO format (hh:mm).
10:30
The number of spots taken.
2
Whether the slot is full.
false
Whether the slot is open.
false
The time when the slot will open if it is not open in 24 hr ISO format (hh:mm).
10:00
Whether the slot closed because it is in the past or doesn't allow booking at this time.
false
Get Eligibility of Members against Areas
Description
Determines whether members in a unit are eligible to schedule a visit in an area of a branch. This allows eligibility to be confirmed without decrementing availability, by checking the member's status and age against the reservation setup of the area. Please note that this resource does not confirm slot availability.
Path Parameters
The ID of the branch.
B12Query Parameters
The ID of the unit.
90000059546Responses
HTTP 200 OK
The list of members in the unit, with details of their area eligibility.
The ID of the member.
90000059546-01
The name of the member.
Ben Adams
Whether the member is active.
true
The list of reservation areas in the branch.
The ID of the area.
A53
The name of the area.
Scheduling Area 1
Whether the member is eligible to make a reservation in this area.
false
The list of reasons why the member is not eligible for the current area. This will be empty if the member is eligible.
["AGE_RESTRICTED","MEMBER_STATUS_RESTRICTED"]
AGE_RESTRICTED, MEMBER_STATUS_RESTRICTED
Book Area Appointments
Description
Book a number of appointments for members of a unit.
Request Body
The ID of the unit.
90000059443
The ID of the branch.
B32
The date for the appointment.
2021-03-08
Whether to send an email after booking the appointment.
true
true
If set to true, allow more than one booking per member in a branch on same day.
false
false
The list of appointments to be booked.
The ID of the member.
90000059443-01
The ID of the area.
A6
The start time of the slot to be booked, in hh:mm format.
10:00
Responses
HTTP 201 Created
The total number of appointments booked.
1
The list of appointments booked.
The ID of the appointment.
44
The ID of the member.
90000059443-01
The name of the member.
Ben Adams
The description of the appointment.
South Ham Area Schedule Visit 3
When the appointment starts.
2021-03-08T10:00:00
When the appointment ends.
2021-03-08T10:30:00
Units
The Units API retrieves member unit data.
Get Unit Details
Description
Gets info and members for a unit
Path Parameters
The ID of the unit
Query Parameters
If true, the members list will include members who are inactive. By default inactive members are filtered.
falseResponses
HTTP 200 OK
The unit's home location
The location identifier.
The location type.
branch
The name of the location.
A list of members associated with the unit
Indicates if the member has an active membership
The member's gender
Standard format for gender type
M, F
User-friendly name of gender
Male, Female
The member's addition gender identity
Indicates if this member is the unit's primary member
A list of related resources and their corresponding URL links.
This describes the relation between the link and the resource returned in the response.
details
The preconstruccted URL to the related resource.
The member's ID
The member's membership type
The member's name
The member's name prefix
The member's first name
The member's middle name
The member's last name
The members' name suffix
The member's preferred name
A list of member photos
The URL of the member photo
The type of member photo
thumbnail, regular
The member's email addresses.
The type of email.
default
The member's email address.
The member's barcode to check-in
Indicates if the member has a photo
The name of the unit
The number of members associated with this unit.
The unit status
Pending, Active, Inactive, Holding, Organization
The unit type
{
"home_location": {
"id": "B123",
"type": "branch",
"name": "Downtown YMCA"
},
"members": [
{
"active": true,
"gender": {
"id": "M",
"name": "Male"
},
"gender_info": null,
"is_primary_member": true,
"links": [
{
"rel": "details",
"href": "/members/300180819-01"
}
],
"member_id": "300180819-01",
"member_type": "Adult",
"name": {
"prefix": "Mr.",
"first_name": "John",
"middle_name": "H.",
"last_name": "Doe",
"suffix": "Jr.",
"preferred_name": "Johnny"
},
"photos": [
{
"url": "https://s3-us-west-1.amazonaws.com/member-photo/2014/6879447-PczzrQ8Bo-vmy52-regular.jpg",
"type": "regular"
},
{
"url": "https://s3-us-west-1.amazonaws.com/member-photo/2014/6879447-PczzrQ8Bo-vmy52-thumbnail.jpg",
"type": "thumbnail"
}
],
"type": "Adult",
"emails": [
{
"type": "default",
"email": "testemail@example.com"
}
],
"barcode": 30018061002,
"has_member_photo": false
},
{
"active": true,
"gender": {
"id": "F",
"name": "Female"
},
"gender_info": null,
"is_primary_member": false,
"links": [
{
"rel": "details",
"href": "/members/300180819-02"
}
],
"member_id": "300180819-02",
"member_type": "Child",
"name": {
"prefix": null,
"first_name": "Samantha",
"middle_name": null,
"last_name": "Doe",
"suffix": null
},
"photos": [
{
"url": "https://s3-us-west-1.amazonaws.com/member-photo/2014/6879448-LvOf3RJ-fTY8q7k-regular.jpg",
"type": "regular"
},
{
"url": "https://s3-us-west-1.amazonaws.com/member-photo/2014/6879448-LvOf3RJ-fTY8q7k-thumbnail.jpg",
"type": "thumbnail"
}
],
"emails": [
{
"type": "default",
"email": "testemail2@example.com"
}
],
"barcode": 30018061001,
"has_member_photo": true
}
],
"type": "Family",
"name": "Doe, John",
"status": "Active"
}
Get Unit Billing Methods
Description
Gets stored billing methods for a unit. This includes all billing methods, even if they are expired (see the expired flag).
Path Parameters
The ID of the unit
Query Parameters
If true, the available_system_credit_amount property will be included in the response. This can be an expensive call, so only set to true when needed.
falseResponses
HTTP 200 OK
Billing method id to use in the checkout call
BM34342533
Billing method id without prefix
34342533
Type of billing method
bank_account, credit_card
Name of the billing method
American Express
Last 4 digits of the account number
3344
Display friendly name of the billing method
American Express (ending in 0005, expires 5/2018)
Whether or not the payment method is expired. Will always be false for method of bank_account.
If include_available_system_credit_amount is true, then this will be the total amount of system credit (including gift cards) that are available on the unit.
15.55
{
"billing_methods": [
{
"id": "BM1955320",
"method": "bank_account",
"name": "EFT",
"account_number_last_4_digits": "1111",
"display_name": "Bank Account (ending in 1111)",
"expired": false
},
{
"id": "BM1955323",
"method": "credit_card",
"name": "VISA",
"account_number_last_4_digits": "1111",
"display_name": "VISA (ending in 1111, expires 5/2015)",
"expired": true
},
{
"id": "BM1965321",
"method": "credit_card",
"name": "MasterCard",
"account_number_last_4_digits": "5100",
"display_name": "MasterCard (ending in 5100, expires 1/2022)",
"expired": false
},
{
"id": "BM1985371",
"method": "credit_card",
"name": "Discover",
"account_number_last_4_digits": "1117",
"display_name": "Discover (ending in 1117, expires 5/2018)",
"expired": false
},
{
"id": "BM1985372",
"method": "credit_card",
"name": "American Express",
"account_number_last_4_digits": "0005",
"display_name": "American Express (ending in 0005, expires 5/2018)",
"expired": false
}
],
"available_system_credit_amount": 10
}
Get unit donations
Description
Retrieves all the donations a unit has made to the organization.
Path Parameters
The ID of the unit.
22342Query Parameters
The start date of the search.
03/03/2023Start of current year i.e. 01/01/2023The end date of the search.
09/03/2023Current date i.e. 08/21/2023Responses
HTTP 200 OK
The sum of the returned donations' pledge totals.
1
The number of donations returned.
1550.5
The start date (UTC) of the search.
2020-01-01T00:00:00.0000000
The end date (UTC) of the search.
2020-09-21T00:00:00.0000000
A summary of the donation
The ID of the donation.
7973941a-caa5-4b2d-a899-8440d2254b32
The ID of the unit who made the donation.
22342
The ID of the member who made the donation.
22342-01
The date when the pledge was made.
2020-09-21T00:00:00.0000000
A summary of the campaign to which the pledge was made.
The code associated with the campaign.
AC021
The name of the campaign.
For a better community.
The total amount pledged.
1550.5
The total amount contributed thus far.
1025.5
The total amount remaining to fulfill the pledge.
525.5
The total amount that has been written off in the pledge.
0
Get unit donation history
Description
Retrieves a historical summary of a unit's donation history over the last six year.
Path Parameters
The ID of the unit.
22342Responses
HTTP 200 OK
A summary of each year's contributions.
The year the contributions were made.
2019
The total amount contributed that year.
1352.99
Get unit dues
Description
Retrieves all the dues for a particular unit.
Path Parameters
The ID of the unit.
Responses
HTTP 200 OK
The dues for the unit.
The ID of the unit.
300181503
The name of the unit.
Unit Name
The ID of the membership type for the unit.
10131
The name of the membership type for the unit.
Family membership
The date in which billing processing will take place for the unit.
2020-09-01T00:00:00.0000000
The ID of the billing cycle.
2
The name of the billing cycle.
Monthly
The ID of the billing method.
3
The name of the billing method.
Invoice
The day of the month when the the draft is applied.
28
The end date of the unit's membership.
2020-10-01T00:00:00.0000000
Whether discounts are allowed for the unit.
true
Whether the membership is auto-renewable.
true
The membership term ID.
0
The membership term.
Monthly
The number of future, scheduled payments on the member's account.
0
The details of unit dues.
The total monthly due amount.
45.31
The string value for monthly dues.
$45.31
A list of all the unit dues.
The ID of the fee.
F71481
The ID of the fee for the unit.
4497304
The fee description.
Full Rate
The fee amount.
50.15
The string value for the amount.
$50.15
The tax amount value.
0.16
The string value of the tax amount.
$0.16
Whether the due can be removed.
false
Whether due is a membership due.
true
The adjustments for unit.
The adjustment amount.
-5.15
The string value for the adjustment amount.
($5.15)
The total taxes for the adjustment.
0.15
The string value for the tax amount.
$0.15
Details about the adjustment.
Complimentary - Recurring
Whether the adjustment is a discount group.
false
The ID of the adjustment fee for the unit.
4537349
The ID of the discount type.
0
The discount type.
Join Fee
The status of the adjustment.
true
{
"due_setup_details": {
"unit_id": "300181503",
"unit_name": "Unit Name",
"membership_type_id": 10131,
"membership_type": "Automation_50_Monthly",
"next_process_date": "2018-02-01T00:00:00.0000000",
"billing_cycle_id": 2,
"billing_cycle_name": "Monthly",
"billing_method_id": 3,
"billing_method_name": "Invoice",
"draft_day": 28,
"membership_end_date": "2001-01-01T00:00:00.0000000",
"discount_allowed": true,
"is_auto_renewable": true,
"membership_term_id": 0,
"membership_term": "Monthly",
"scheduled_payment_count": 0
},
"unit_dues": {
"total_monthly_dues": "$45.31",
"total_monthly_dues_value": 45.31,
"dues": [
{
"fee_id": "F71481",
"fee_unit_id": 4497304,
"fee_description": "Full Rate",
"amount_value": 50.15,
"amount": "$50.15",
"tax_amount_value": 0.16,
"tax_amount": "$0.16",
"can_be_removed": false,
"is_membership_due": true,
"adjustments": [
{
"adjustment_amount_value": -5.15,
"adjustment_amount": "($5.15)",
"tax_amount_value": 0.15,
"tax_amount": "$0.15",
"adjustment_description": "Complimentary - Recurring",
"is_discount_group": false,
"fee_unit_id": 4537349,
"discount_type_id": 0,
"discount_type": "Join Fee",
"approved": true
}
]
}
]
}
}
Get Unit Fees
Description
Retrieves the fee charged on the unit.
Path Parameters
The ID of the unit.
300181503Query Parameters
The page number.
11The number of records to be fetched.
1025Responses
HTTP 200 OK
Whether there are more records to be fetched on subsequent calls.
false
The total number of fees returned.
1
The fees charged on the unit.
The debit ID of the fee.
12345678
The ID of the fee.
f2afb945-2052-48b1-aa5b-f5f2a628e8cf
The grouping ID.
300180566-01_0
The ID of the member with whom the fee is associated. If the fee is not associated with any member then 0.
30018056-01
The registration ID of the member for a program for which the fee is charged.
1234
The registration ID of the meber for a child-care program for which the fee is charged.
4474635
The date on which the fee was charged, in MM/dd/YYYY format.
10/14/2020
The description of the charged fee.
2009 Rate Increase - Family.
The amount of the fee.
5.15
The total tax for the fee.
0.05
The discount amount paid for the fee.
0.05
The scheduled amount for the fee.
0.05
The due date of the fee in MM/dd/YYYY format.
10/14/2020
Whether the payment is overdue for the fee.
true
The minimum payment amount for the fee.
5.15
Whether the fee can be removed.
true
Add charge to unit
Description
Adds a one-time fee to the unit.
Path Parameters
The ID of the unit.
300181503Request Body
The ID of the branch of the unit.
B38
The ID of the fee.
1234
The quantity of the specified fees that should be applied to the unit.
1
The amount to be applied.
10.01
The description of the fee.
One time Fee
Responses
HTTP 201 Created
Delete charge from unit
Description
Deletes a charge from a unit.
Path Parameters
The ID of the unit.
300181503The ID of the fee to be removed.
77ae13b3-c645-4bca-bb01-d8855ecd879aResponses
HTTP 204 No Content
List Relationship Sources
Description
Gets relationship information for members in a unit.
People in the sources list are people that would be at the root of the relationship. People in the children list are people that can be assigned
to people in the sources list as related.
For example: if Robert is Susie's grandfather, Robert would be in the sources list and Susie would be in the children list. Once Susie is marked
as related to Robert, the sources.person.relationships array for Robert would contain an entry for Susie's member_id and authorized_pickup would
denote if Robert is allowed to pick up Susie from programs as an authorized pickup.
Path Parameters
The ID of the unit
Responses
HTTP 200 OK
List of people that can be the source/root of a relationship. If the sources.person.relationships is empty, then no relationships/authorized pickups have been established.
Identifies this person for relationships API calls. You should not store this ID as it could change and is only intended to be used for the relationships API calls.
Details about this person.
First name
Last name
Address line 1
Address line 2
Address city/town
Address state/region
Address zip code/postal code
Address country code
Phone number
555-123-1111
Email address
Birth date in ISO format (YYYY-MM-DD)
Child's member id.
Relationship type of source to this child. For example, if Robert the source and Sue is the child, then the relationship type id would be REL110 (grandfather)
Value should be true if the source is authorized to pick up this member_id.
List of people in the unit that can be attached as a relationship to a person in the sources array.
Member ID of this person
First name
Last name
Birth date in ISO format (YYYY-MM-DD)
{
"sources": [
{
"source_id": "RELMEM6880034",
"person": {
"name": {
"first": "Robert",
"last": "Doe"
},
"address": {
"line1": "8611 Greenway Rd.",
"line2": "",
"city": "Homewood",
"state": "AL",
"zip": "35209",
"country": "US"
},
"phone": {
"number": "(555) 555-5555"
},
"email": "johndoe@example.org",
"birth_date": "1950-05-01",
"relationships": [
{
"member_id": "12345-03",
"relationship_type_id": "REL110",
"authorized_pickup": true
},
{
"member_id": "12345-04",
"relationship_type_id": "REL110",
"authorized_pickup": false
}
]
}
}
],
"children": [
{
"member_id": "12345-03",
"name": {
"first": "Billy",
"last": "Doe"
},
"birth_date": "2005-08-21"
},
{
"member_id": "12345-04",
"name": {
"first": "Susie",
"last": "Doe"
},
"birth_date": "2014-03-20"
}
]
}
Create Relationship Source
Description
Creates a new person that is not a member in the unit and assigns relationships/authorized pickups.
NOTE: this should be used to capture information about a person that is not a member of this unit. For example, if Robert is Susie's grandfather (but is not a member on the unit) and needs to be entered as Susie's authorized pickup, then you would create a relationship here. If you want to assign a relationships to existing adults in the unit, you should get a list of existing adults with the get-relationship sources endpoint and then update this person's relationships with the update-relationship sources endpoint
Path Parameters
The ID of the unit
Request Body
Details about this person.
First name
Last name
Address line 1
Address line 2
Address city/town
Address state/region
Address zip code/postal code
Address country code
Phone number
555-123-1111
Email address
Birth date in ISO format (YYYY-MM-DD)
Child's member id.
Relationship type of source to this child. For example, if Robert the source and Sue is the child, then the relationship type id would be REL110 (grandfather)
Value should be true if the source is authorized to pick up this member_id.
Responses
HTTP 200 OK
Value is true if the operation was successful.
HTTP 400 Bad Request
Description of error_message
If attempting to create a duplicate source, then the source_id of the duplicate will be returned.
Update Relationship Source
Description
Updates a relationship source. Use source_id and child member_id from the get-relationship sources endpoint API call.
Path Parameters
The ID of the unit
The source id of the person being updated.
Request Body
Details about this person.
First name
Last name
Address line 1
Address line 2
Address city/town
Address state/region
Address zip code/postal code
Address country code
Phone number
555-123-1111
Email address
Birth date in ISO format (YYYY-MM-DD)
Child's member id.
Relationship type of source to this child. For example, if Robert the source and Sue is the child, then the relationship type id would be REL110 (grandfather)
Value should be true if the source is authorized to pick up this member_id.
Responses
HTTP 200 OK
Value is true if the operation was successful.
Delete Relationship Source
Description
Deletes all relationships for a source. If the source is NOT a member in the unit and was created via the create-relationship sources endpoint, then the source will be completely deleted. If the source is a member of the unit, then the source will still exist in the get-relationship sources endpoint API call but all relationships to children will be deleted.
Path Parameters
The ID of the unit
The source id of the person.
Responses
HTTP 200 OK
Value is true if the operation was successful.
List Relationship Types
Description
Gets relationship types.
Responses
HTTP 200 OK
List of relationship types
ID for relationship type
Human readable description of relationship type
{
"relationship_types": [
{
"relationship_type_id": "REL10",
"description": "Mother"
},
{
"relationship_type_id": "REL20",
"description": "Father"
},
{
"relationship_type_id": "REL30",
"description": "Sister"
},
{
"relationship_type_id": "REL40",
"description": "Brother"
},
{
"relationship_type_id": "REL50",
"description": "Aunt"
},
{
"relationship_type_id": "REL60",
"description": "Uncle"
},
{
"relationship_type_id": "REL70",
"description": "Niece"
},
{
"relationship_type_id": "REL80",
"description": "Nephew"
},
{
"relationship_type_id": "REL90",
"description": "Cousin"
},
{
"relationship_type_id": "REL100",
"description": "Grandmother"
},
{
"relationship_type_id": "REL110",
"description": "Grandfather"
},
{
"relationship_type_id": "REL120",
"description": "Stepsister"
},
{
"relationship_type_id": "REL130",
"description": "Stepbrother"
},
{
"relationship_type_id": "REL140",
"description": "Stepmother"
},
{
"relationship_type_id": "REL150",
"description": "Stepfather"
},
{
"relationship_type_id": "REL160",
"description": "Friend"
},
{
"relationship_type_id": "REL170",
"description": "Neighbor"
},
{
"relationship_type_id": "REL180",
"description": "Guardian"
},
{
"relationship_type_id": "REL190",
"description": "Teacher"
}
]
}
Get Unit Transactions
Description
Retrieves the transactions for the unit.
Path Parameters
The ID of the unit.
90000059443Query Parameters
Optionally, whether to filter the query by the category of transaction. If not specified, it will default to all transactions.
all_transactionsall_transactions, fees, payments
The start date for the search date range. If not specified, it will default to 30 days ago.
2020-02-15The end date for the search date range. If not specified, it will default to 30 days from the start date.
2020-02-26The page number of the response. If not included in the request, its default value will be 1.
1The number of transactions fetched per response, defaulting to 25.
20Responses
HTTP 200 OK
The total number of transactions fetched on this page of the response.
1
A list of transactions.
The Credit/Debit/Payment ID of the transaction.
53363142
The timestamp (in UTC) when the transaction occurred.
2020-07-10T16:06:01.4770000
The ID of the unit for the transaction.
90000059443
The description of the transaction.
Super Cool After School Program — 5 days a week (12/29/14 - 06/01/15)
The amount for the transaction, including taxes, formatted as money.
$750.00
The amount for the transaction, including taxes, in decimal format.
750
The type of transaction (e.g. credit or debit).
Debit
The type of credit or debit applied (e.g., Payment, Fees, Discount, Cancellation, etc.).
Fees
The total taxes for the transaction, formatted as money.
$0.00
The total taxes for the transaction, in decimal format.
0
The registration ID of the program the transaction is related to (only available if the type of the program is Child Care).
4474636
The type of program.
Child Care
Whether there are more records on the next page.
false
Get Discount Groups Applied to Unit
Description
Retrieves the discount groups applied to the unit.
Path Parameters
The ID of the unit.
300181503Responses
HTTP 200 OK
The discount groups applied to the unit.
The ID of the discount group.
DG2050
The name of the discount group.
YMCA Part-Time Employees
The notice of the discount group.
Renews in June. Family Upgrades $27 upgrade fee as of 2009.
The description of the discount group.
The description of the discount group.
The ID of the branch.
B38
The name of the branch.
Downtown Branch
The discount amount of the discount group.
The join-fee amount.
10.11
The join-fee discount.
0.05
The join-fee subsidy.
0.05
The net join-fee.
10.01
The membership-fee amount.
10.11
The membership-fee discount.
0.05
The membership-fee subsidy.
0.05
The net membership-fee.
10.01
Add Discount Group To Unit
Description
Applies a discount group to a specific unit. Please note that this operation is asynchronous, so the applied discount group may not be reflected in the account for up to one minute.
Path Parameters
The ID of the unit.
300181503Request Body
The ID of the discount group.
DG1234
Responses
HTTP 202 Accepted
Get Unit Agreements
Description
Retrieves all the signed waivers and agreements on record for the unit.
Path Parameters
The ID of the unit.
90000059443Responses
HTTP 200 OK
The total number of agreements for the unit.
1
A list of agreements for the unit.
The ID of the agreement.
AWP43
The name of the agreement.
Swimming liability waiver
The type of agreement signed.
Program
Program, Childcare, Membership
The ID of the unit to which this agreement belongs to.
90000059443
The ID of the member to which this agreement belongs to.
90000059443-02
The name of the member to which this agreement belongs to.
Doe, Smith
How the agreement was signed.
Typed name
Typed Name, Signature, Staff Override
When the agreement was accepted.
2020-09-07T00:00:00Z
Get Unit Agreement Details
Description
Retrieves all the signed waivers and agreements on record for the unit.
Path Parameters
The ID of the unit.
90000059443The ID of the agreement.
AWC42Responses
HTTP 200 OK
The ID of the agreement.
AWP43
The name of the agreement.
Swimming liability waiver
The type of agreement signed.
Program
Program, Childcare, Membership
The ID of the unit to which this agreement belongs to.
90000059443
The ID of the member to which this agreement belongs to.
90000059443-02
The name of the member to which this agreement belongs to.
Doe, Smith
How the agreement was signed.
Typed name
Typed Name, Signature, Staff Override
When the agreement was accepted.
2020-09-07T00:00:00Z
The content of the agreement.
tl;dr;: — Just keep swimming! Long version: Legalese and vernacular about the perils of swim lessons et al, liability-indemnification clauses and other multi-syllabic jargon in both English and Latin.
Get Unit Past-Due Balances
Description
Retrieves the past-due balances of a unit.
Path Parameters
The ID of the unit.
90000059443Responses
HTTP 200 OK
The total number of past-due balances of the unit.
1
A list of past-due balances.
The debit ID of the fee.
53363142
The description of the fee.
Membership Due (Feb.)
The amount of the fee.
83
The remaining amount or balance of the fee.
83
The due date of the fee.
2013-02-01T00:00:00.0000000
Get Unit Schedule Payments
Description
Retrieves the scheduled payments of a unit.
Path Parameters
The ID of the unit.
90000059443Responses
HTTP 200 OK
The total number of schedule payments of the unit.
1
A list of schedule payments.
The debit ID of the fee.
52885059
The payment ID of the fee.
36684706
The payment schedule ID of the fee.
0
The description of the fee.
Membership Due (Feb.)
The amount of the fee.
57
The due date of the fee.
2011-12-01T00:00:00.0000000
The scheduled amount of the fee.
57
The scheduled date of the fee.
2011-12-28T00:00:00.0000000
Get Termination Reasons
Description
Retrieves a list of reasons to choose from to terminate the membership of a unit.
Responses
HTTP 200 OK
The total mumber of reasons.
7
A list of reasons.
["Annual Invoice: Did not Renew","Bad debt","Credit card expiration","Deceased","Dissatisfied","Financial burden","Illness"]
Unit Membership Termination
Description
Terminates the membership of the unit with fee management.
Path Parameters
The ID of the unit.
300181503Request Body
When to terminate the membership of the unit (cannot be in past).
2021-09-25
The reason to terminate the membership. See Get Termination Reasons endpoint.
Illness
Any additional notes to be provided while terminating.
Terminated at South Hampton
A list of debit IDs of past-due balances (associated with the unit) to be written-off. See Get Unit Past-Due Balances endpoint.
[53052386,53052387,53052390]
A list of debit IDs of scheduled payments (associated with the unit) to be removed. See Get Unit Schedule Payments endpoint.
[52885059,52885099]
Responses
HTTP 201 Created
HTTP 400 Bad Request
HTTP 500 Internal Server Error
Get Unit Balance
Description
Retrieves the current balance for a unit's account, along with its gift-card balance and any applicable credits.
Path Parameters
The ID of the unit
0293423Responses
HTTP 200 OK
The total balance, after all credits and unfulfilled pledges have been applied.
30.55
The amount the unit owes on its account.
20
The amount the unit has pledged to the association but has yet to pay.
10.55
The amount the unit is to receive from the association in credits but has not received yet.
0
The amount the unit's account has been credited by the system.
0
The amount that the unit has paid above its standard fees.
0
The total amount the unit has in gift cards.
0
Get Applied Discount Group
Description
Retrieves the details of the applied discount group.
Path Parameters
The ID of the unit.
300181503The ID of the discount group.
DG2050Responses
HTTP 200 OK
The ID of the discount group.
DG2050
The name of the discount group.
YMCA Part-Time Employees
The notice of the discount group.
Renews in June. Family Upgrades $27 upgrade fee as of 2009.
The description of the discount group.
The description of the discount group.
The ID of the branch.
B38
The name of the branch.
Downtown Branch
The discount amount of the discount group.
The join-fee amount.
10.11
The join-fee discount.
0.05
The join-fee subsidy.
0.05
The net join-fee.
10.01
The membership-fee amount.
10.11
The membership-fee discount.
0.05
The membership-fee subsidy.
0.05
The net membership-fee.
10.01
Whether the discount group is active.
true
Whether the discount group is from promotion.
false
The ID of the promotion type.
2
0, 1, 2
The type of the membership promotion.
automatic
none, code_generic, automatic
The promo code for the promotion.
ABC
The status of the discount group.
completed
draft, completed
Whether the discount is applied to all members of the unit.
true
The full name of the discount group.
Discount Group Name (PromoCode)
Delete Applied Discount Group
Description
Removes a discount group from a unit.
Path Parameters
The ID of the unit.
300181503The ID of the discount group.
DG2050Responses
HTTP 204 No Content
Get Draft Days
Description
Retrieves a list of options of draft days for dues setup available in the system.
Responses
HTTP 200 OK
A list of draft days available in the system.
[15,28,30]
Get unit-billing-cycle options
Description
Retrieves a list of billing cycles available in the system, with each billing cycle having its own set of possible next process dates.
Path Parameters
The ID of the unit.
90000059443Responses
HTTP 200 OK
A list of billing cycles.
The ID of the billing cycle.
2
The name of the billing cycle.
Monthly
A list of possible new next process date for corresponding billing cycle.
["03-2025","04-2025","05-2025","06-2025","07-2025","08-2025","09-2025","10-2025","11-2025","12-2025","01-2026","02-2026","03-2026","04-2026","05-2026","06-2026","07-2026","08-2026"]
Update Unit Due Setup
Description
Updates the due setup of the unit. The fields which are not provided in the request body are not updated.
Path Parameters
The ID of the unit.
90000059443Request Body
The ID of the new billing method (prefixed with BM). You may use the get-unit-billing-methods endpoint to see a list of available billing methods for the unit.
BM2055682
The new draft day. You may use the get-draft-days endpoint to see a list of available draft days.
15
The ID of the new billing cycle. You may use the get-unit-billing-cycles endpoint to see a list of available billing cycles.
2
Whether to enable or disable the auto-renew status of the unit.
true
Responses
HTTP 204 No Content
Update Unit Next Process Date
Description
Updates the next process date of the unit.
Path Parameters
The ID of the unit.
90000059443Request Body
The new next process date in mm-yyyy format. You may use the get-unit-billing-cycles endpoint to see options for new next process dates.
03-2021
Responses
HTTP 204 No Content
Update Unit Termination Date
Description
Updates the termination date of the unit.
Path Parameters
The ID of the unit.
90000059443Request Body
The new termination date in mm-yyyy format. You may use the get-unit-billing-cycles endpoint to see options for new termination dates.
03-2021
Responses
HTTP 204 No Content
Get Unit Appointments
Description
Retrieves the appointments for a particular unit.
Path Parameters
The ID of the unit.
4723647872Query Parameters
The start date from when the appointments should be fetched.
2021-01-31The end date till when the appointments should be fetched. If not provided, this will default to 1 year from the start date.
2022-01-31The member ID to filter the appointments for a particular member.
4723647872-01The location ID to filter the appointments for a particular branch or a site.
B123The type to filter the results for a particular type of appointment.
areaservice, instructor, area
The type to filter the results for online or in-house.
in_houseonlinein_house, online
Responses
HTTP 200 OK
The total number of appointments returned.
1
The appointments booked in the unit.
The ID of the appointment.
1
The ID of the Area Rental. Appointments with the same appointment_registration_id represents a single Area Rental across multiple areas.
10151
The title of the appointment.
Branch Visit
The duration of appointment in minutes.
120
The start date and time of the appointment.
2021-02-20T12:00:00.0000000
The end date and time of the appointment.
2021-02-20T14:00:00.0000000
The date and time when the appointment was booked.
2021-01-31T10:57:04.3330000
The date for when the appointment was booked.
2021-02-20T00:00:00.0000000
The ID of the location for which the appointment was booked.
S123
The name of the location for which the appointment was booked.
Downtown Site
The ID of the member for which the appointment was booked.
4723647872-02
The name of the member for which the appointment was booked.
John Doe
The type of appointment.
area
service, instructor, area
The ID of the area for which the appointment was booked. This will only be returned if the appointment corresponds to a scheduled-branch visit.
A1
The name of the area for which the appointment was booked. This will only be returned if the appointment corresponds to a scheduled-branch visit.
ABC Area
The total number of packages in the program. This will only be returned if the appointment corresponds to a package-program appointment.
10
The total number of appointments booked for the package program. This will only be returned if the appointment corresponds to a package-program appointment.
2
The ID of the program for which the offering belongs. This will only be returned if the appointment corresponds to a package-program appointment.
PP12345
The ID of the offering for which the appointment is booked. This will only be returned if the appointment corresponds to a package-program appointment.
PKG9876
The name of the instructor with whom the appointment is booked. This will only be returned if the appointment corresponds to a package-program appointment.
John Smith
Whether more appointments can be booked for the program. This will only be returned if the appointment corresponds to a package-program appointment.
true
Whether more packages are avaialable for booking. This will only be returned if the appointment corresponds to a package-program appointment.
true
Cancel Appointment
Description
Cancels an appointment for a particular unit.
Path Parameters
The ID of the unit.
4723647872The ID of the appointment to be deleted.
123Request Body
Whether to send an email after canceling the appointment.
false
true
Whether to cancel all the appointments overlapping with the current appointment.
false
true
If set to true, the appointment will be deleted even if it is in the past.
false
true
Responses
HTTP 204 No Content
Tokens
The Tokens API allows developers to store sensitive information on Daxko servers and to retrieve that information in a PCI-compliant way.
Create payment token
Description
Tokenizes a credit card or bank account. This endpoint should be used as a JSONP endpoint.
Query Parameters
Adding the Authorization: Bearer <jwt> header is not possible when using this endpoint as a JSONP call. Instead, you can
use this parameter to pass in the same value, omitting the Bearer header prefix.
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...The Javascript callback function that will be executed on return. If the callback parameter is set to cb,
then response would be formatted like
cb({
"payment_token":"3rapMp...",
"last_four_digits":"1111"
})
The type of payment account to tokenize. Additional fields in the body will vary depending on the type.
bank_account, credit_card
The following fields are required to be specified as a JSV-formatted string when payment_type is bank_account:
- account_holder_name
- account_type
- account_number
- routing_number
{account_holder_name:Jane%20Doe,account_type:checking,account_number:1231231231234,routing_number:123123123}The following fields are required to be specified as a JSV-formatted string when payment_type is credit_card:
- card_holder_name
- number
- exp_month
- exp_year
- address_line_1
- address_zip
{card_holder_name:John%20Doe, number:4111111111111111,...}Responses
HTTP 201 Created
The created payment token. This can be used as part of the checkout process.
C3yY9phklLPFX8A4UlZrxzODzbbWhqVULfeBWOVQ1Ps
The last four digits of the account number that was tokenized. This can be used for user identification and verification that the proper payment method is being used.
1111